1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
资产中心资产组数数据信息查询
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeResourceGroupNew。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
QueryType | 是 | String | 查询类型 网络结构-vpc,业务识别-resource ,资源标签-tag 示例值:tag |
GroupId | 否 | String | 资产组id 全部传0 示例值:cfwrg-id* |
ShowType | 否 | String | all 包含子组 own自己 示例值:ALL |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | String | 返回树形结构 示例值:[{"GroupId":"cfwrg-130044**node","ParentId":"0","GroupName":"全部资产","Cidr":"mastercidr","Path":"/全部资产/","InsNum":52,"TreeChild":[{"GroupId":"cfwrg-17***349477","ParentId":"cfwrg-1300448058masternode","GroupName":"clay","Cidr":"mastercidr","Path":"/全部资产/clay/","InsNum":1,"TreeChild":[]}]}] |
ReturnCode | Integer | 返回码;0为请求成功 示例值:0 |
ReturnMsg | String | 接口返回消息 示例值:success |
UnResourceNum | Integer | 未分类实例数量 示例值:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 资产中心资产组数数据信息查询
资产中心资产组数数据信息查询
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourceGroupNew
<公共请求参数>
{
"GroupId": "cfwrg-****node",
"QueryType": "resource",
"ShowType": "all"
}
输出示例
{
"Response": {
"Data": "[{\"GroupId\":\"cfwrg-130044******node\",\"ParentId\":\"0\",\"GroupName\":\"全部资产\",\"Cidr\":\"mastercidr\",\"Path\":\"/全部资产/\",\"InsNum\":52,\"TreeChild\":[{\"GroupId\":\"cfwrg-17***********349477\",\"ParentId\":\"cfwrg-1300448058masternode\",\"GroupName\":\"clay\",\"Cidr\":\"mastercidr\",\"Path\":\"/全部资产/clay/\",\"InsNum\":1,\"TreeChild\":[]}]}]",
"RequestId": "60e4d0ea-f89a-4cfa-b132-64449c7e894a",
"ReturnCode": 0,
"ReturnMsg": "success",
"UnResourceNum": 5
}
}
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签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |