1. 接口描述
接口请求域名: ioa.tencentcloudapi.com 。
获取业务资源列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeBusinessResources。 |
| Version | 是 | String | 公共参数,本接口取值:2022-06-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Condition | 否 | Condition | 滤条件、分页参数。分页内容不传,默认获取第1页,10条数据 |
| AreaId | 否 | Integer | 资源模块Id 示例值:2 |
| ServiceName | 否 | String | 服务名称 示例值:HR系统 |
| Keywords | 否 | String | 搜索关键字 示例值:HR |
| StartTime | 否 | String | 获取业务资源列表的开始时间,时间格式:2006-01-02 示例值:2026-09-03 00:02:41 |
| EndTime | 否 | String | 获取业务资源列表的结束时间,时间格式:2006-01-02 示例值:2026-09-03 23:02:41 |
| AccessType | 否 | String | 资源类型 示例值:domain |
| FrontAddr | 否 | String | web资源前端地址 示例值:* |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeBusinessResourcePageRsp | 业务资源分页返回对象 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询资源列表
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBusinessResources
<公共请求参数>
{}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"APISecretId": 0,
"AccessType": 0,
"AreaId": 8,
"AreaName": "sjntest",
"BackendPath": "",
"BackendScheme": "",
"CertificateId": 0,
"CnameStatus": 0,
"ConnectorGroupId": "d9unlkvpf1kbvg5841og",
"ConnectorGroupName": "国际站test",
"ConnectorGroupType": "native",
"CreateTime": "2026-08-13 17:39:59",
"CustomDomain": "",
"CustomHost": "",
"DependentAddr": "",
"DetectInfo": "**",
"DetectState": 1,
"DetectTime": "2026-08-13 17:39:59",
"DirectConn": 0,
"DisableFront": 0,
"DomainSuffix": "260210447.global.renwox.com",
"EnableDependentAddr": 0,
"FrontHost": "",
"FrontPath": "",
"FrontPort": 0,
"FrontScheme": "",
"Levels": 5000,
"Protocol": 2,
"ReachableState": 0,
"ReachableTime": "",
"Remark": "",
"SSLCertId": "",
"ServiceAddress": "*.qq.com",
"ServiceId": 15,
"ServiceName": "测sjntest",
"ServicePort": "all",
"ServiceType": "domain",
"SmartGateIds": [
6
],
"SmartGateNames": "smartgate;",
"UpdateTime": "2026-08-13 17:40:00",
"WebGwNoAuth": 1,
"WebGwResourceType": 0
}
],
"Page": {
"PageCount": 1,
"PageNum": 1,
"PageSize": 10,
"Total": 6
}
},
"RequestId": "00fbdd4b-9f36-431e-8c68-cb811c931c53"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DatabaseException | 内部错误,数据库异常。 |
| InvalidParameter.RequestParam | 请求参数错误。 |