Help Center/ Relational Database Service/ API Reference/ API v3/ Database and Account Management (Microsoft SQL Server)/ Changing the Character Set of a DB Instance
Updated on 2026-08-25 GMT+08:00
View PDF
Share

Changing the Character Set of a DB Instance

Function

This API is used to change the character set of a DB instance.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:update

write

instance

- g:EnterpriseProjectId

- g:ResourceTag/<tag-key>

rds:instance:modify

-

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/collations

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

collation

Yes

String

Definition

New character set.

Constraints

N/A

Range

You can obtain the value of this parameter from charSets in Table 2 by calling the API for querying available SQL Server character sets.

Default Value

N/A

Example Request

Change the character set of an instance to Chinese_PRC_CI_AS.

PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin04/collations

{
  "collation" : "Chinese_PRC_CI_AS"
}

Response

  • Normal response
    Table 3 Response body parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

    Task ID.

    Range

    N/A
  • Example normal response 
    { 
  "job_id" : "7be09cc4-c269-4f3a-9539-aaf2b40d79a0" 
}
  • Abnormal response

    For details, see Abnormal Response Results.

Status Code

Error Code

For details, see Error Codes.