获取资源监控列表

最近更新时间: 2026-09-17 00:02:48

1. 接口描述

接口请求域名: cwp.api3.fincloud.tencent.cn。

获取资产指纹页面的资源监控列表

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

接口更新时间:2022-09-28 15:55:30。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeAssetMachineList
Version String 公共参数,本接口取值:2018-02-28
Region String 公共参数,地域信息本接口不需要传递此参数。
By String 可选排序[FirstTime
Filters Array of Filter 过滤条件。
  • MachineName  主机名称
  • InstanceID  实例ID  
  • IP   内网IP或公网IP
  • OsType - String - 是否必填:否 - windows或linux
  • CpuLoad - Int - 是否必填:否 - 
    0: 未知  1: 低负载
    2: 中负载  3: 高负载
  • DiskLoad - Int - 是否必填:否 - 
    0: 0%或未知  1: 0%~20%
    2: 20%~50%  3: 50%~80%
    4: 80%~100%
  • MemLoad - Int - 是否必填:否 - 
    0: 0%或未知  1: 0%~20%
    2: 20%~50%  3: 50%~80%
    4: 80%~100%
  • Quuid:主机Quuid
  • OsName -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口 值 )

  • 示例值:查看
    Limit Uint64 需要返回的数量,默认为10,最大值为100
    示例值: 10
    Offset Uint64 偏移量,默认为0。
    示例值: 0
    Order String 排序方式,asc升序 或 desc降序
    示例值: asc

    3. 输出参数

    参数名称 类型 描述
    Machines Array of AssetMachineBaseInfo 记录列表
    示例值:查看
    Total Uint64 总数
    示例值: 1
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter.MissingParameter 参数缺失。
    MissingParameter 缺少参数错误。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。

    5. 示例

    示例1 获取资源监控列表

    获取资源监控列表

    输入示例

    POST / HTTP/1.1
    Host: cwp.api3.fincloud.tencent.cn
    Content-Type: application/json
    X-TC-Action: DescribeAssetMachineList
    <Public request parameters>
    
    {}
    

    输出示例

    {
        "Response": {
            "Total": 1,
            "Machines": [
                {
                    "Quuid": "24c9be55-c743-4a75-a5c7-2a2912341234",
                    "Uuid": "24c9be55-c743-4a75-a5c7-2a2912341234",
                    "MachineIp": "10.0.0.11",
                    "MachineName": "test-name",
                    "OsInfo": "CentOs Bit64",
                    "Cpu": "Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz",
                    "MemSize": 1,
                    "MemLoad": "49",
                    "DiskSize": 1,
                    "DiskLoad": "41",
                    "PartitionCount": 1,
                    "MachineWanIp": "110.84.0.11",
                    "ProjectId": 1,
                    "CpuSize": 1,
                    "CpuLoad": "Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz",
                    "Tag": [
                        {
                            "Rid": 0,
                            "Name": "test-name",
                            "TagId": 1
                        }
                    ],
                    "UpdateTime": "2024-10-11 12:23:34",
                    "IsNew": 0,
                    "FirstTime": "2024-10-11 12:23:34",
                    "MachineExtraInfo": {
                        "WanIP": "110.84.0.11",
                        "PrivateIP": "10.0.0.11",
                        "NetworkType": 0,
                        "NetworkName": "vpc-12341234",
                        "InstanceID": "ins-aj28fjz",
                        "HostName": "test-name"
                    }
                }
            ],
            "RequestId": "37b6df34-68f1-4ab8-a3d8-7b89de604c82"
        }
    }