Domain name for API request: sqlserver.tencentcloudapi.com.
This API is used to modify database remarks.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ModifyDBRemark. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-28. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID in the format of mssql-rljoi3bf |
DBRemarks.N | Yes | Array of DBRemark | Array of database names and remarks, where each element contains a database name and the corresponding remarks |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://sqlserver.tencentcloudapi.com/?Action=ModifyDBRemark
&InstanceId=mssql-njj2mtpl
&DBRemarks.0.Name=db_test
&DBRemarks.0.Remark=Test database
&<Common request parameters>
{
"Response": {
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError.DBError | Database error |
InternalError.GcsError | GCS API error. |
InternalError.SystemError | System error. |
InvalidParameter | Invalid parameter. |
InvalidParameter.InputIllegal | Input error. |
InvalidParameterValue.DataBaseRemarkIsIllegal | The database remarks are invalid. |
ResourceNotFound.DBNotFound | The database does not exist. |
ResourceNotFound.InstanceNotFound | The instance does not exist. |
ResourceUnavailable.InstanceStatusInvalid | Invalid instance status. |
UnauthorizedOperation.PermissionDenied | CAM authentication error. |
Was this page helpful?