Domain name for API request: mariadb.tencentcloudapi.com.
This API is used to query the information of primary and replica nodes of an instance.
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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter. The value used for this API: DescribeInstanceNodeInfo. |
Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID, such as tdsql-6ltok4u9 |
Limit | No | Integer | The maximum number of results returned at a time. By default, there is no upper limit to this value, that is, all results can be returned. |
Offset | No | Integer | Offset of the returned results. Default value: 0 . |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total number of nodes |
NodesInfo | Array of NodeInfo | Node information |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: mariadb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceNodeInfo
<Common request parameters>
{
"InstanceId": "tdsql-b43f8yjl"
}
{
"Response": {
"RequestId": "186315",
"NodesInfo": [
{
"Role": "master",
"NodeId": "5c2af09aeeb701fef6d5fef4329bb62d61f211ac"
},
{
"Role": "slave",
"NodeId": "dbedea66f4ba2b71e6816e3f9d0c2936e5448786"
},
{
"Role": "slave",
"NodeId": "1b40c8a28bec5c4af666d31b24119e319d68773e"
}
],
"TotalCount": 3
}
}
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 |
---|---|
FailedOperation.OssOperationFailed | Failed to request the backend API. |
InternalError.InnerSystemError | Internal system error. |
InvalidParameter.InstanceNotFound | Failed to find the requested instance. |
Was this page helpful?