绑定或解绑数据库实例DB

最近更新时间:2025-01-15 01:15:07

我的收藏

1. 接口描述

接口请求域名: dsgc.tencentcloudapi.com 。

绑定或解绑数据库实例DB

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:BindDSPAResourceDatabases。
Version String 公共参数,本接口取值:2019-07-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, ap-singapore 。
DspaId String DSPA实例ID。
示例值:dspa-ab50f3b1
ResourceId String 数据库实例ID。
示例值:cdb-6cmpe42v
MetaType String 数据库实例类型。
示例值:cdb
BindDbItems.N Array of DbResourceItem 绑定DB列表。
示例值:[{"DbName":"asset"}]
UnbindDbItems.N Array of DbResourceItem 解绑DB列表。
示例值:[{"DbName":"asset_info"}]

3. 输出参数

参数名称 类型 描述
DbTaskResults Array of DbTaskResult 绑定结果数组
示例值:[{"Result":"success","ResultDescription":"task-desc","ErrDescription":{"ErrCode":"2131","ErrMessage":"参数错误"},"ResourceId":"cdb-a1b2c3","DbName":"asset"}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 绑定或解绑数据库

批量绑定数据库实例db

输入示例

POST / HTTP/1.1
Host: dsgc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BindDSPAResourceDatabases
<公共请求参数>

{
    "DspaId": "dspa-ab43cd12",
    "ResourceId": "cdb-mpe42va5",
    "MetaType": "cdb",
    "BindDbItems": [
        {
            "DbName": "test001"
        }
    ],
    "UnbindDbItems": [
        {
            "DbName": "test002"
        }
    ]
}

输出示例

{
    "Response": {
        "DbTaskResults": [
            {
                "Result": "success",
                "ResultDescription": "update db bind status to [binded] success",
                "ErrDescription": {
                    "ErrCode": "InternalError",
                    "ErrMessage": "internal error"
                },
                "ResourceId": "cdb-mpe42va5",
                "DbName": "test001"
            }
        ],
        "RequestId": "91c7a73v-e540-4780-8b8e-74e0b65b4f1a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。