Last updated: 2019-09-09 14:59:26


1. API Description

API domain name:

This API (ModifyDBRemark) modifies remarks of the specified database.

API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The name of this API: ModifyDBRemark
Version Yes String Common parameter. The version of this API: 2018-03-28
Region Yes String Common parameter. For more information, 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

3. Output Parameters

Parameter name Type Description
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Example 1. Modifying Database Remarks

Input Sample Code
&DBRemarks.0.Remark=Test database
&<Common request parameter>

Output Sample Code

  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InternalError.DBError Database error.
InternalError.SystemError System error.
InvalidParameter Incorrect parameter.
InvalidParameter.InputIllegal Invalid input.
ResourceNotFound.DBNotFound The database does not exist.
ResourceNotFound.InstanceNotFound The instance does not exist.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.