Domain name for API request: cdwdoris.tencentcloudapi.com.
This API is used to obtain the database information under a specific data source.
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: DescribeDatabase. |
Version | Yes | String | Common Params. The value used for this API: 2021-12-28. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Resource ID, which is the TCHouse-D resource ID used for table creation. |
UserName | No | String | Use the user who has corresponding permissions for operations. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in. |
PassWord | No | String | Password corresponding to the user. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in. |
CatalogName | No | String | Query the data source where the database is located. If it is not filled in, the internal data source (internal) will be used by default. |
DbNames.N | No | Array of String | The database information to be queried. If this parameter and FilterDbName are not filled in, all database information of the current data source will be queried by default. |
FilterDbName | No | String | Display the filtered database information. For example, %infor indicates database names ending with infor. This parameter only supports scenarios where CatalogName is internal. |
Parameter Name | Type | Description |
---|---|---|
DbInfos | Array of DbInfo | Database information Note: This field may return null, indicating that no valid values can be obtained. |
Message | String | Error message Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to obtain the database information of the internal data source.
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabase
<Common request parameters>
{
"InstanceId": "cdwdoris-bjizjxxx",
"CatalogName": "internal"
}
{
"Response": {
"DbInfos": [
{
"DbName": "test",
"Location": "",
"Properties": null
},
{
"DbName": "db1",
"Location": "",
"Properties": [
{
"PropertyKey": "min_load_replica_num",
"PropertyValue": "-1"
},
{
"PropertyKey": "replication_allocation",
"PropertyValue": "tag.location.default: 3"
}
]
}
],
"Message": "",
"RequestId": "43516a7e-aa6c-4f43-8435-71d4e41dbd8a"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
本页内容是否解决了您的问题?