接口功能介绍

根据筛选条件查询资源池下指定产品的列表。

接口约束

参见请求参数说明。

URI

POST /v4/monitor/canvas/query-resource-list

路径参数 无

Query参数 无

请求参数

请求头header参数 无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
dimension	是	String	维度	cstor_sfs
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
projectID	否	String	企业项目ID	0
pageNo	否	Integer	页码，默认为1	1
pageSize	否	Integer	页大小，默认为10	1
enumFilter	否	Array of Objects	筛选列表		enumFilterInObj
searchFilter	否	Array of Objects	模糊匹配列表		searchFilterInObj

表 enumFilterInObj

参数	是否必填	参数类型	说明	示例	下级对象
key	是	String	筛选关键字	gatewayStatus
value	是	String	筛选值	running

表 searchFilterInObj

参数	是否必填	参数类型	说明	示例	下级对象
key	是	String	模糊匹配关键字	gatewayStatus
value	是	String	模糊匹配值	running

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败），默认值：800	800
errorCode	String	失败时的错误代码，参见公共错误码说明
message	String	失败时的错误描述，一般为英文描述	Success
msgDesc	String	失败时的错误描述，一般为中文描述	成功
error	String	错误码，请求成功时，不返回该字段	Openapi.Parameter.Error
returnObj	Object	返回对象		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
totalPage	Integer	总页数	1
currentCount	Integer	当前页记录数	30
totalCount	Integer	资源总记录数	30
pageSizeUpper	Integer	分页上限	50
pageSupport	Boolean	是否支持分页	true
items	Array of Objects	资源列表		itemObj
enumFilter	Array of Objects	筛选列表		enumFilterObj
searchFilter	Array of Objects	模糊匹配列表		searchFilterObj
tableHeaders	Array of Objects	表头		tableHeaderObj

表 tableHeaderObj

参数	参数类型	说明	示例	下级对象
key	String	表头关键字	gatewayStatus
description	String	表头名称	状态

表 searchFilterObj

参数	参数类型	说明	示例
key	String	模糊查询关键字	gatewayStatus
desc	String	模糊查询对应的名称	状态
type	String	本参数表示模糊查询类型。取值范围： general：普遍。 instanceName：实例名称。 instanceID：实例ID。根据以上范围取值。	general
isPrecise	Boolean	本参数表示搜索类型。取值范围： true：精确匹配。 false：模糊匹配。根据以上范围取值。	false

表 enumFilterObj

参数	参数类型	说明	示例	下级对象
key	String	筛选关键字	gatewayStatus
desc	String	筛选对应的名称	状态
enumValues	Array of Objects	筛选枚举值		enumValueObj

表 enumValueObj

参数	参数类型	说明	示例	下级对象
key	String	枚举关键字	deploying
value	String	枚举值	部署中

表 itemObj

参数	参数类型	说明	下级对象
monitorDimensions	Array of Objects	维度信息	monitorDimension
display	Array of Objects	展示属性	displayObj
baseInfo	Object	基础信息	baseInfoObj
childInfo	Array of Objects	子设备查询信息	childInfoObj

表 monitorDimension

参数	参数类型	说明	示例	下级对象
key	String	维度字段	uuid
data	Array of Objects	维度信息		dataObj

表 dataObj

参数	参数类型	说明	示例	下级对象
value	String	维度值	123456789
desc	String	维度描述	ecm-4567

表 displayObj

参数	参数类型	说明	示例
key	String	展示字段	uuid
value	String	展示字段的值	1234567
description	String	展示字段描述	主机id

表 baseInfoObj

参数	参数类型	说明	示例	下级对象
instanceID	String	实例ID	123456789
instanceName	String	实例名称	ecm-4567

表 childInfoObj

参数	参数类型	说明	示例	下级对象
childKey	String	子设备查询标签	lisid
childDimension	String	子设备对应的维度	listener
childRequestInfo	Array of Objects	子设备查询信息		childRequestInfoObj

表 childRequestInfoObj

参数	参数类型	说明	示例	下级对象
key	String	子设备查询键	uuid
value	String	子设备查询键对应的值	5ac245b3-dd9b-75c3-cee5-d1b674bb0d69

枚举参数

无

请求示例

请求url

/v4/monitor/canvas/query-resource-list

请求头header

无

请求体body

{
    "dimension":"gateway",
    "regionID":"81f7728662dd11ec810800155d307d5b",
    "pageNo":1,
    "pageSize":10,
    "enumFilter":[
        {
            "key":"gatewayStatus",
            "value":"running"
        }
    ],
    "searchFilter":[
        {
            "key":"searchName",
            "value":"cloud",
            "type":"general",
            "isPrecise":false
        }
    ]
}

响应示例

{
    "statusCode": 800,
    "returnObj": {
        "items": [
            {
                "monitorDimensions": [
                    {
                        "key": "uuid",
                        "data": [
                            {
                                "value": "267e6c62-1743-11ef-94a4-f479609929b9",
                                "desc": "cloud6zhongyuchenggongle"
                            }
                        ]
                    }
                ],
                "display": [
                    {
                        "key": "gatewayName",
                        "value": "cloud6zhongyuchenggongle",
                        "description": "名称"
                    },
                    {
                        "key": "projectID",
                        "value": "0",
                        "description": "企业项目"
                    },
                    {
                        "key": "gatewayStatus",
                        "value": "运行中",
                        "description": "网关状态"
                    },
                    {
                        "key": "gatewayIP",
                        "value": "192.168.0.73",
                        "description": "网关IP"
                    },
                    {
                        "key": "endpointServiceID",
                        "value": "",
                        "description": "VPCE服务ID"
                    }
                ],
                "details": {
                    "endpointServiceID": "",
                    "gatewayID": "267e6c62-1743-11ef-94a4-f479609929b9",
                    "gatewayIP": "192.168.0.73",
                    "gatewayName": "cloud6zhongyuchenggongle",
                    "gatewayPosition": "ctyun",
                    "gatewaySpec": "standard",
                    "gatewayStatus": "running",
                    "gatewayType": "file_gw",
                    "projectID": "0",
                    "regionID": "81f7728662dd11ec810800155d307d5b"
                },
                "baseInfo": {
                    "instanceID": "267e6c62-1743-11ef-94a4-f479609929b9",
                    "instanceName": "cloud6zhongyuchenggongle"
                },
                "childInfo": [
                    {
                        "childKey": "cache",
                        "childDimension": "gateway_child_cache",
                        "childRequestInfo": [
                            {
                                "key": "gatewayID",
                                "value": "267e6c62-1743-11ef-94a4-f479609929b9"
                            }
                        ]
                    }
                ]
            }
        ],
        "totalCount": 1,
        "totalPage": 1,
        "currentCount": 1,
        "pageSizeUpper": 50,
        "pageSupport": true,
        "enumFilter": [
            {
                "key": "gatewayStatus",
                "desc": "状态",
                "enumValues": [
                    {
                        "key": "deploying",
                        "desc": "部署中"
                    },
                    {
                        "key": "running",
                        "desc": "运行中"
                    },
                    {
                        "key": "deleting",
                        "desc": "删除中"
                    },
                    {
                        "key": "frozen",
                        "desc": "已过期"
                    }
                ]
            }
        ],
        "searchFilter": [
            {
                "key": "searchName",
                "desc": "请输入名称"
            }
        ],
        "tableHeaders": [
            {
                "key": "gatewayName",
                "description": "名称"
            },
            {
                "key": "projectID",
                "description": "企业项目"
            },
            {
                "key": "gatewayStatus",
                "description": "网关状态"
            },
            {
                "key": "gatewayIP",
                "description": "网关IP"
            },
            {
                "key": "endpointServiceID",
                "description": "VPCE服务ID"
            }
        ]
    },
    "errorCode": "",
    "message": "Success",
    "msgDesc": "成功"
}

状态码

请参考状态码

错误码

请参考错误码

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云监控服务

云监控服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云监控服务

云监控服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码