1. 接口描述
接口请求域名： dcdb.tencentcloudapi.com 。
获取实例灾备详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDcnDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：tdsqlshard-hqtjy5d1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DcnDetails | Array of DcnDetailItem | DCN同步详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取实例灾备详情
获取实例灾备详情
输入示例
POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDcnDetail
<公共请求参数>
{
"InstanceId": "tdsqlshard-hqtjy5d1"
}输出示例
{
"Response": {
"DcnDetails": [
{
"Cpu": 0,
"CreateTime": "2022-11-08 17:43:48",
"DcnFlag": 1,
"DcnStatus": 0,
"EncryptStatus": 0,
"InstanceId": "tdsqlshard-hqtjy5d1",
"InstanceName": "tdsqlshard-hqtjy5d1",
"InstanceType": 2,
"Memory": 0,
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"Region": "ap-guangzhou",
"Status": 2,
"StatusDesc": "运行中",
"Storage": 0,
"Vip": "172.16.16.86",
"Vipv6": "",
"Vport": 3306,
"Zone": "ap-guangzhou-3"
},
{
"Cpu": 0,
"CreateTime": "2022-11-08 17:56:43",
"DcnFlag": 2,
"DcnStatus": 2,
"EncryptStatus": 0,
"InstanceId": "tdsqlshard-c06stiq3",
"InstanceName": "tdsqlshard-c06stiq3",
"InstanceType": 3,
"Memory": 0,
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"Region": "ap-guangzhou",
"Status": 2,
"StatusDesc": "运行中",
"Storage": 0,
"Vip": "172.16.16.18",
"Vipv6": "",
"Vport": 3306,
"Zone": "ap-guangzhou-3"
}
],
"RequestId": "f1989672-5114-4289-a0b5-3b5b4c11dccc"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.InnerSystemError | 内部系统错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |
