1. 接口描述
接口请求域名: dsgc.tencentcloudapi.com 。
添加用户云上资源列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDSPAMetaResources。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, ap-singapore 。 |
MetaType | 是 | String | 资源类型,支持:cdb(云数据库 MySQL)、dcdb(TDSQL MySQL版)、mariadb(云数据库 MariaDB)、postgres(云数据库 PostgreSQL)、cynosdbpg(TDSQL-C PostgreSQL版)、cynosdbmysql(TDSQL-C MySQL版) 示例值:cdb |
ResourceRegion | 是 | String | 资源所处地域。 示例值:ap-guangzhou |
DspaId | 是 | String | DSPA实例ID。 示例值:dspa-12cd45g7 |
UpdateStatus | 是 | String | 用来标记本次更新是否已经是最后一次,可选值:continue(后续还需要更新)、finished(本次是最后一次更新)。 示例值:continue |
UpdateId | 是 | String | 本次更新的ID号,用来标记一次完整的更新过程。 示例值:1 |
Items.N | 是 | Array of DspaUserResourceMeta | 资源列表。 示例值:[item1,itme2] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
UpdateId | String | 本次更新的ID号,用来标记一次完整的更新过程。 示例值:1 |
MetaType | String | 资源类型,支持:cdb(云数据库 MySQL)、dcdb(TDSQL MySQL版)、mariadb(云数据库 MariaDB)、postgres(云数据库 PostgreSQL)、cynosdbpg(TDSQL-C PostgreSQL版)、cynosdbmysql(TDSQL-C MySQL版) 示例值:cbd |
DspaId | String | DSPA实例ID。 示例值:dspa-a1b2 |
ResourceRegion | String | 资源所处地域。 示例值:ap-guangzhou |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
添加用户云上资源列表示例
输入示例
POST / HTTP/1.1
Host: dsgc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDSPAMetaResources
<公共请求参数>
{
"DspaId": "dspa-ed415837",
"UpdateId": "49f060ba-c12d-4643-98da-aa8bcc382091",
"UpdateStatus": "finished",
"Items": [
{
"ResourceVip": "127.0.0.1",
"ResourceId": "cdb-16cb45g7",
"ResourceCreateTime": "2022-12-03 10:42:19",
"ResourceUniqueSubnetId": "subnet-xx",
"ResourceUniqueVpcId": "vpc-xx",
"ResourceName": "name",
"ResourceVPort": 1
}
],
"MetaType": "mariadb",
"ResourceRegion": "ap-guangzhou"
}
输出示例
{
"Response": {
"RequestId": "6542ea46-5974-42b2-8876-f1ca946a92ce",
"DspaId": "dspa-ed415837",
"MetaType": "mariadb",
"ResourceRegion": "ap-guangzhou",
"UpdateId": "49f060ba-c12d-4643-98da-aa8bcc382091"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
LimitExceeded | 超过配额限制。 |
ResourceNotFound | 资源不存在。 |