Update a MySQL database's default character settings

PATCH/v2/mysql-databases/{mysqlDatabaseId}/default-charset

API-Version

Request-Methode

PATCH

Operation-ID

deprecated-database-update-mysql-database-default-charset

Request

mysqlDatabaseIdstringrequired
ID of the MySQLDatabase to update.

Format

application/json

characterSettingsobjectrequired
- characterSetstringrequired
  A valid MySQL character set. Refer to the MySQL manual‍ for more information and available character sets.
  
  You can also use the GET /v2/mysql-charsets endpoint‍ to query available character sets for your MySQL database.
- collationstringrequired
  A valid MySQL collation. Refer to the MySQL manual‍ for more information and available collations.
  
  You can also use the GET /v2/mysql-charsets endpoint‍ to query available character sets (and collations of these character sets) for your MySQL database.

Content-Type: application/json

{
  "characterSettings": {
    "characterSet": "utf8mb4",
    "collation": "utf8mb4_general_ci"
  }
}

{
  "properties": {
    "characterSettings": {
      "properties": {
        "characterSet": {
          "description": "A valid MySQL character set. Refer to the [MySQL manual](https://dev.mysql.com/doc/refman/8.4/en/charset-mysql.html)\nfor more information and available character sets.\n\nYou can also use the [`GET /v2/mysql-charsets` endpoint](/docs/v2/reference/database/database-list-mysql-charsets/)\nto query available character sets for your MySQL database.\n",
          "example": "utf8mb4",
          "type": "string"
        },
        "collation": {
          "description": "A valid MySQL collation. Refer to the [MySQL manual](https://dev.mysql.com/doc/refman/8.4/en/charset-mysql.html)\nfor more information and available collations.\n\nYou can also use the [`GET /v2/mysql-charsets` endpoint](/docs/v2/reference/database/database-list-mysql-charsets/)\nto query available character sets (and collations of these character sets) for your MySQL database.\n",
          "example": "utf8mb4_general_ci",
          "type": "string"
        }
      },
      "required": [
        "characterSet",
        "collation"
      ],
      "type": "object"
    }
  },
  "required": [
    "characterSettings"
  ]
}

Responses

Kein Response-Inhalt angegeben.

Format

application/json

Beschreibung

Validation Error caused by invalid input data in the request

type"ValidationError"required
messagestring
validationErrorsArray von objectrequired
- Array[
  - *object
    - messagestringrequired
      The standard error message
    - pathstringrequired
      The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.
    - typestringrequired
      ajv validation error type (e.g. "format", "required", "type") or own validation error types
    - contextobject
      The object with the additional information about the error that can be used to create custom error messages. Keys depend on the type that failed validation (e.g. "missingProperty" for type "required")
      - *string
  ]

Content-Type: application/json

{
  "type": "ValidationError",
  "message": "Validation failed",
  "validationErrors": [
    {
      "message": "should be string",
      "path": ".address.street",
      "type": "format",
      "context": {
        "format": "email"
      }
    }
  ]
}

{
  "type": "object",
  "required": [
    "type",
    "validationErrors"
  ],
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "ValidationError"
      ]
    },
    "message": {
      "type": "string",
      "example": "Validation failed"
    },
    "validationErrors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message",
          "path",
          "type"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "The standard error message",
            "example": "should be string"
          },
          "path": {
            "type": "string",
            "description": "The path to the part of the data that was validated. JavaScript property access notation (e.g., \".prop[1].subProp\") is used.\n",
            "example": ".address.street"
          },
          "type": {
            "type": "string",
            "description": "ajv validation error type (e.g. \"format\", \"required\", \"type\") or own validation error types",
            "example": "format"
          },
          "context": {
            "type": "object",
            "example": {
              "format": "email"
            },
            "description": "The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. \"missingProperty\" for type \"required\")\n",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Format

application/json

Beschreibung

An unexpected Error that occurred while handling the request

messagestringrequired
typestringrequired

Content-Type: application/json

{
  "message": "Something went wrong",
  "type": "InternalServerError"
}

{
  "type": "object",
  "required": [
    "type",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "example": "Something went wrong"
    },
    "type": {
      "type": "string",
      "example": "InternalServerError"
    }
  }
}

Format

application/json

Beschreibung

Your request ran into a rate limit. You have to wait until rate limit expires

messagestring
typestring

Content-Type: application/json

{
  "message": "too many requests",
  "type": "RateLimitError"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "too many requests"
    },
    "type": {
      "type": "string",
      "example": "RateLimitError"
    }
  }
}

Format

application/json

Beschreibung

An unexpected Error that occurred while handling the request

messagestringrequired
typestringrequired

Content-Type: application/json

{
  "message": "Something went wrong",
  "type": "InternalServerError"
}

{
  "type": "object",
  "required": [
    "type",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "example": "Something went wrong"
    },
    "type": {
      "type": "string",
      "example": "InternalServerError"
    }
  }
}

Nutzungsbeispiele

$ curl \
    --fail \
    --location \
    -X PATCH \
    -d '{"characterSettings":{"characterSet":"utf8mb4","collation":"utf8mb4_general_ci"}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/mysql-databases/string/default-charset

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.database.deprecatedDatabaseUpdateMysqlDatabaseDefaultCharset({
  "mysqlDatabaseId": "string",
  "data": {
    "characterSettings": {
      "characterSet": "utf8mb4",
      "collation": "utf8mb4_general_ci"
    }
  }
});

assertStatus(response, 204);
  

use \Mittwald\ApiClient\Generated\V2\Clients\Database\DeprecatedDatabaseUpdateMysqlDatabaseDefaultCharset\DeprecatedDatabaseUpdateMysqlDatabaseDefaultCharsetRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Database\DeprecatedDatabaseUpdateMysqlDatabaseDefaultCharset\DeprecatedDatabaseUpdateMysqlDatabaseDefaultCharsetRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// DeprecatedDatabaseUpdateMysqlDatabaseDefaultCharsetRequestBody to learn how to construct a valid instance
$body = new DeprecatedDatabaseUpdateMysqlDatabaseDefaultCharsetRequestBody(/* TODO: ... */);

$request = (new DeprecatedDatabaseUpdateMysqlDatabaseDefaultCharsetRequest(
  mysqlDatabaseId: "string",
  body: $body
));
$response = $client->database()->deprecatedDatabaseUpdateMysqlDatabaseDefaultCharset($request);

var_dump($response->getBody();
  

Update a MySQL database's default character settings

Request​

Pfad-Parameterrequired

Request-Bodyrequired

Responses​

No Content204

Bad Request400

Not Found404

Too Many Requests429

default

Nutzungsbeispiele​

Auf dieser Seite

Request

Responses

Nutzungsbeispiele