1. 接口描述
接口请求域名: dsgc.tencentcloudapi.com 。
拉取用户云资源
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListDSPAMetaResources。 |
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-a1b2c3d4 |
Filters.N | 否 | Array of DspaDataSourceMngFilter | 过滤项。 可过滤值包括: ResoureRegion - 资源所处地域,需要填写完整地域名称,不支持模糊匹配。 AuthStatus - authorized(已授权)、unauthorized(未授权)、deleted(资源已被删除),不支持模糊匹配,需要填写完整。 BuildType - cloud(云原生资源)、build(用户自建资源),不支持模糊匹配,需要填写完整。 MetaType - cdb(云数据Mysql)、dcdb(TDSQL MySQL版)、mariadb(云数据库 MariaDB)、postgres(云数据库 PostgreSQL)、cynosdbmysql(TDSQL-C MySQL版)、cos(对象存储)、mysql_like_proto(自建型Mysql协议类关系型数据库)、postgre_like_proto(自建型Postgre协议类关系型数据库)。 ResourceId - 资源ID,支持模糊搜索。 CvmID - 自建资源对应CvmId,如:ins-xxxxxxxx。该字段用于casb调用dsgc接口时,根据cvmId和vport确定具体的自建实例 示例值:[ { "Name":"ResourceId", "Values":[ "mariadb-9loqa8ed" ] } ] |
Limit | 否 | Integer | 分页步长,默认为100。 示例值:10 |
Offset | 否 | Integer | 分页偏移量,默认为0。 示例值:0 |
BindType | 否 | String | 资源绑定状态过滤,默认为全部 示例值:binded |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DspaId | String | DSPA实例ID。 示例值:dspa-a1b2c3 |
Resources | Array of DspaUserResourceMeta | 用户资源列表。 示例值:[123] |
TotalCount | Integer | 资源总量。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取Dspa实例下数据源信息
获取Dspa实例下的资源信息
输入示例
POST / HTTP/1.1
Host: dsgc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListDSPAMetaResources
<公共请求参数>
{
"DspaId": "dspa-6fb60936",
"Filters": [
{
"Name": "ResourceId",
"Values": [
"mariadb-9loqa8ed"
]
}
]
}
输出示例
{
"Response": {
"DspaId": "dspa-a1b2dc78",
"Resources": [
{
"ResourceId": "mariadb-3578e092",
"ResourceName": "test123",
"ResourceVip": "172.16.0.12",
"ResourceVPort": 3306,
"ResourceCreateTime": "2022-01-02 15:04:05",
"ResourceUniqueVpcId": "vpc-73299612",
"ResourceUniqueSubnetId": "subnet-awkdpmnn",
"MetaType": "mariadb",
"ResourceRegion": "ap-guangzhou",
"ResourceSyncTime": "2022-01-02 15:04:05",
"AuthStatus": "authorized",
"BuildType": "cloud",
"MasterInsId": "cdb-a1",
"ResourceVpcId": 1,
"ResourceSubnetId": 1,
"Protocol": "mysql",
"ResourceVersion": "10.2.3",
"ResourceAuthType": "auto",
"ResourceAuthAccount": "test123",
"InstanceType": "mariadb",
"InstanceValue": "mariadb-78693a6c",
"GovernAuthStatus": 0,
"AuthRange": "manual"
}
],
"TotalCount": 1,
"RequestId": "715f6d81-d277-4f90-8089-f4d048a629d4"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.UnauthorizedOperation | 未授权的操作。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
ResourceNotFound | 资源不存在。 |