1. 接口描述
接口请求域名: cloudrc.tencentcloudapi.com 。
搜索资源
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SearchResources。 |
| Version | 是 | String | 公共参数,本接口取值:2024-06-06。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| ViewId | 否 | String | 视图ID 示例值:vw-42dfl9y1 |
| MaxResults | 否 | Integer | 每页返回的最大记录数 示例值:10 |
| NextToken | 否 | String | 分页Token,首次查询不传 示例值:fsyNjBUtwUUGuHeSCnd5PiDz7jR9Fbe0Zegjt1OjpJLq9RFeXTU2e+YUOCXdrR7cp9WxaydUTd4fHZo2lBJdwAQeLj7/mmZzBHm+YFxmhjpO6YE/WGmI1vladteuoN7IzQefWu+FAq4K0XiagxPUeUf7CpAfuSgU6JWPs+HS8lNGVzqzzULRVUc0GmOGLo1eUFGfhOT79iwLii2tG+l6NQ== |
| Filters.N | 否 | Array of ExtendedFilter | 过滤条件列表 |
| SortBy | 否 | String | 排序条件 枚举值:
示例值:ExpireTime |
| SortOrder | 否 | String | 排序顺序 枚举值:
默认值:Asc 示例值:Asc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NextToken | String | 下一页Token,为空时表示无更多数据 示例值:cCuk41e5JoaacP6PzhydNNStUM5couVJsUY7klW3qet5afBsukPVCXcoxUCPUKqjLbDDjuaDL3cC5XRuEeAMgi/I/niv6ZxB0DgTIxXnSqU4ehEYAKgHOR6uVc1aDaQnAKiuk4bOLqtxYuppLEd2N2WFoJrxLMUwvvX8Bw9DzXJ9zCHD5eD0oa81KYmKolmdAjViZfdi0kcvw4qv4uaTdzDEHoc= |
| Resources | Array of ResourceSummary | 资源列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询广州的资源
输入示例
POST / HTTP/1.1
Host: cloudrc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchResources
<公共请求参数>
{
"Filters": [
{
"Key": "RegionCode",
"Values": [
"ap-guangzhou"
]
}
]
}
输出示例
{
"Response": {
"NextToken": "cCuk41e5JoaacP6PzhydNNStUM5couVJsUY7klW3qet5afBsukPVCXcoxUCPUKqjLbDDjuaDL3cC5XRuEeAMgi/I/niv6ZxB0DgTIxXnSqU4ehEYAKgHOR6uVc1aDaQnAKiuk4bOLqtxYuppLEd2N2WFoJrxLMUwvvX8Bw9DzXJ9zCHD5eD0oa81KYmKolmdAjViZfdi0kcvw4qv4uaTdzDEHoc=",
"Resources": [
{
"CreateTime": "2017-12-05 15:28:22",
"PayMode": "Free",
"PrivateIpAddress": [],
"PublicIpAddress": [],
"RegionCode": "ap-guangzhou",
"ResourceAlias": "******Test",
"ResourceId": "vpc-m3ul053f",
"ResourceType": "qcs::vpc::vpc",
"Tags": [],
"Uin": 909600000
}
],
"RequestId": "64ec7bde-2b9b-4b65-b66a-676a795d84ea"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ApiParamError | Api参数校验不通过 |
| ResourceNotFound.ViewIdNotFound | 视图ID不存在 |