Modifies the description of an account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyAccountDescription | The operation that you want to perform. Set the value to ModifyAccountDescription. |
RegionId | String | Yes | cn-hangzhou | The ID of the region where your PolarDB-X instance is deployed. |
DBInstanceName | String | Yes | pxc-hzjasd**** | The name of the PolarDB-X instance. |
AccountName | String | Yes | account | The username of the account whose description you want to modify. |
AccountDescription | String | No | AccountForTest | The new description of the account. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Message | String | msg | The message that is returned. If the request is successful, "success" is returned. If the request fails, an error code is returned. |
RequestId | String | FEA5DC20-6D8A-5979-97AA-FC57546ADC20 | The ID of the request. |
Success | Boolean | true | Indicates whether the request is successful. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ModifyAccountDescription
&RegionId=cn-hangzhou
&DBInstanceName=pxc-hzjasd****
&AccountName=account
&AccountDescription=AccountForTest
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyAccountDescriptionResponse>
<Message>msg</Message>
<RequestId>FEA5DC20-6D8A-5979-97AA-FC57546ADC20</RequestId>
<Success>true</Success>
</ModifyAccountDescriptionResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "msg",
"RequestId" : "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
"Success" : true
}
Error codes
For a list of error codes, visit the API Error Center.