获取组件统计列表

最近更新时间:2018-12-07 20:46:33

1. 接口描述

接口请求域名: yunjing.tencentcloudapi.com 。

本接口 (DescribeComponentStatistics) 用于获取组件统计列表数据。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeComponentStatistics
Version String 公共参数,本接口取值:2018-02-28
Region String 公共参数,本接口不需要传递此参数。
Limit Integer 返回数量,默认为10,最大值为100。
Offset Integer 偏移量,默认为0。
Filters.N Array of Filter 过滤条件。
ComponentName - String - 是否必填:否 - 组件名称

3. 输出参数

参数名称 类型 描述
TotalCount Integer 组件统计列表记录总数。
ComponentStatistics Array of ComponentStatistics 组件统计列表数据数组。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取组件统计列表

输入示例

https://yunjing.tencentcloudapi.com/?Action=DescribeComponentStatistics
&Limit=10
&Offset=0
&<公共请求参数>

输出示例

{
  "Response": {
    "ComponentStatistics": [
      {
        "ComponentName": "machine-name",
        "ComponentType": "WEB",
        "Description": "description",
        "Id": 100010,
        "MachineNum": 10
      }
    ],
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "TotalCount": 100
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError 内部错误
InvalidParameter.IllegalRequest 非法请求。
InvalidParameter.InvalidFormat 参数格式错误。
InvalidParameter.ParsingError 参数解析错误。
MissingParameter 缺少参数错误