You can call the DescribeInstanceKeywords operation to query the reserved keywords of an ApsaraDB RDS instance. The reserved keywords cannot be used for the usernames of accounts or the names of databases.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstanceKeywords

The operation that you want to perform. Set the value to DescribeInstanceKeywords.

Key String Yes account

The type of reserved keyword to query. Valid values:

  • account
  • database

Response parameters

Parameter Type Example Description
RequestId String 1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

The ID of the request.

Key String account

The type of reserved keyword returned.

Words List "dbo,login,admin,administrator"

An array that consists of reserved keywords.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstanceKeywords
&Key=account
&<Common request parameters>

Sample success responses

XML format

<RequestId>DB6A907E-8686-4F66-8F2B-B31071CDE766</RequestId>
<Words>
    <word>dbo,login,admin,administrator</word>
</Words>
<Key>account</Key>

JSON format

{
  "RequestId": "DB6A907E-8686-4F66-8F2B-B31071CDE766",
  "Words": {
    "word": [
      "dbo,login,admin,administrator"
    ]
  },
  "Key": "account"
}

Error codes

For a list of error codes, visit the API Error Center.