1. 接口描述
接口请求域名： dsgc.tencentcloudapi.com 。
拉取DSPA集群列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListDSPAClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, ap-singapore 。 |
| Limit | 否 | Integer | 分页步长，默认为100。 示例值：100 |
| Offset | 否 | Integer | 分页偏移量，默认为0。 示例值：0 |
| Filters.N | 否 | Array of DspaDataSourceMngFilter | 过滤项。 支持的过滤项包括：DspaId、Status、Version、DspaName、Channel。 DspaId和DspaName支持模糊搜索。 Status支持的可选值：enabled、disabled。 Version支持的可选值：trial、official。 Channel支持的可选值：sp_cds_dsgc_pre（代表dsgc实例）、sp_cds_dsgc_wedata_dc（代表wedata实例） 示例值： [ { "Name": "Channel", "Values": [ "dsgc" ] }, { "Name": "DspaName", "Values": [ "订单实例" ] } ] |
| ListMode | 否 | String | 展示模式。 目前只有两个值的处理逻辑： 空值：需要查询每个实例的配额信息，因为是串行查询，所以速度很慢，limit最大为100 "simple"：不需要查询每个实例的配额信息，速度快，limit最大为1000 示例值：simple |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 资源总数。 示例值：100 |
| InstanceList | Array of DspaInstance | 资源列表。 示例值：[ { "AppId": 251205474, "DspaId": "dspa-44b7bd87", "DspaName": "dspa-44b7bd87", "DspaDescription": "dspa-44b7bd87", "InsAuthCount": 0, "DBAuthCount": 0, "CosBindCount": 0, "InstanceVersion": "professional", "Status": "enabled", "ExpiredAt": 1733034406, "TrialVersion": "", "TrialEndAt": 18446744011573955000, "InsTotalQuota": 5, "DbTotalQuota": 5, "CosTotalQuota": 1, "CosQuotaUnit": "T", "RenewFlag": 0, "Channel": "dsgc" } ] |
| DenyAll | Boolean | 是否被拒绝访问所有dspa实例资源。 示例值：false |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取DSPA实例列表
拉取DSPA实例列表
输入示例
POST / HTTP/1.1
Host: dsgc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListDSPAClusters
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"Filters": [
{
"Name": "Channel",
"Values": [
"dsgc"
]
}
]
}输出示例
{
"Response": {
"TotalCount": 1,
"InstanceList": [
{
"DspaId": "dpsa-a1b2c3d4",
"DspaName": "订单分类分级实例",
"DspaDescription": "上汽集团下级机构",
"DBAuthCount": 1,
"CosBindCount": 1,
"InstanceVersion": "basic",
"Status": "enabled",
"ExpiredAt": 1730366388,
"AppId": 125500778,
"TrialVersion": "trial-standard",
"TrialEndAt": 0,
"DbTotalQuota": 3,
"CosTotalQuota": 3,
"CosQuotaUnit": "T",
"RenewFlag": 1,
"Channel": "wedata",
"InsAuthCount": 0,
"InsTotalQuota": 0
}
],
"DenyAll": true,
"RequestId": "18dafbf7-83d5-4159-aeaf-4a02f1975176"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
