跳转至

资源上下线

1. 接口说明

用于将资源批量上线或下线。

版本支持

本文接口契约适用于 CAN 发布版本:V1.62.10+V2.3.0+

2、 接口URL

POST http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/resourceVersion/updateResourcesStatus

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

3、 请求参数

3.1、 公共请求参数(HEADERS)

参数 类型 是否必选 描述
tenant-id String 租户 ID,用于标识资源所属租户
auth-type String 认证方式。支持 UIDTOKENACCOUNTAPIKEY
auth-value String auth-type 对应的认证值

3.1.1 公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成,在 API 集成界面获取;auth-value 请按 auth-type 填写对应认证值。

3.2 请求体参数

参数 类型 是否必选 描述
resourceType String 资源类型:METRIC:指标DIMENSION:维度
resourceIds Array 资源 ID 列表
status String ONLINE:上线 OFFLINE:下线

4. 请求示例

curl --location 'http://localhost:8083/anymetrics/api/v1/resourceVersion/updateResourcesStatus' \
--header 'tenant-id: tn_xxx' \
--header 'auth-value: 492376865890107392' \
--header 'auth-type: UID' \
--header 'Content-Type: application/json' \
--data '{
  "resourceType": "METRIC",
  "resourceIds": [
    "mcd5ccd4ed7ab8d03d84d1d2e71c95a2"
  ],
  "status": "ONLINE"
}'