实例组接口

更新时间：2024-01-26

创建实例组

请求结构体

Method: Post

Url: /csm/api/v1/userId/{userId}/instance-group

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	Path
mergedGroup	MergedGroup		是	requestBody

响应参数

名称	类型	描述
id	Long	实例组Id
name	String	实例组名称
serviceName	String	云服务名称
typeName	String	对象类型
region	String	区域
userId	String	用户Id
uuid	String	实例组UUID
count	int	实例组含有实例数量
serviceNameAlias	String	云服务中文名称
typeNameAlias	String	对象类型中午名称
regionAlias	String	区域中文名称
tagKey	String	实例组对应Tag，格式为：INSTANCEGROUP:

请求示例

POST /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance-group
  
  
request body:
{
    "name": "group_name",
    "region": "bj",
    "typeName": "Instance",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "serviceName": "BCE_BCC",
    "resourceIdList": [
        {
            "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
            "region": "bj",
            "serviceName": "BCE_BCC",
            "typeName": "Instance",
            "resourceId": "InstanceId:04b91096-a294-477d-bd11-1a7bcfbxxxxx"
        }
    ]
}

响应示例

{
    "id": 7900,
    "name": "group_name",
    "serviceName": "BCE_BCC",
    "typeName": "Instance",
    "region": "bj",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "uuid": "6c9a3ce6-b984-4bf7-9868-b81ec17xxxxx",
    "count": 0,
    "serviceNameAlias": null,
    "typeNameAlias": null,
    "regionAlias": null,
    "tagKey": "",
    "typeTarget": ""
}

更新实例组名称

请求结构体

Method: Patch

Url：/csm/api/v1/userId/{userId}/instance-group

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	Path
group	Group	实例组信息	是	requestBody

Group

名称	类型	说明	是否必须
id	Long	实例组Id	是
name	String	更新后实例组名称	是
serviceName	String	云服务名称	是
typeName	String	对象类型，如实例、集群	是
region	String	区域	是

响应参数

名称	类型	描述
id	Long	实例组Id
name	String	实例组名称
serviceName	String	云服务名称
typeName	String	对象类型
region	String	区域
userId	String	用户Id
uuid	String	实例组UUID
count	int	实例组含有实例数量
serviceNameAlias	String	云服务中文名称
typeNameAlias	String	对象类型中午名称
regionAlias	String	区域中文名称
tagKey	String	实例组对应Tag，格式为：INSTANCEGROUP:

请求示例

PATCH  /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance-group
  
  
request Body
{
    "id":7900,
    "name":"group_name_new",
    "region":"bj",
    "serviceName":"BCE_BCC",
    "typeName":"Instance"
}

响应示例

{
    "id": 7900,
    "name": "group_name_new",
    "serviceName": "BCE_BCC",
    "typeName": "Instance",
    "region": "bj",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "uuid": "5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
    "count": 0,
    "serviceNameAlias": null,
    "typeNameAlias": null,
    "regionAlias": null,
    "tagKey": "",
    "typeTarget": ""
}

删除实例组

请求结构体

Method: Delete

Url: /csm/api/v1/userId/{userId}/instance-group/{id}

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	Path
id	Long	实例组Id	是	Path

响应参数

名称	类型	描述
id	Long	实例组Id
name	String	实例组名称
serviceName	String	云服务名称
typeName	String	对象类型
region	String	区域
userId	String	用户Id
uuid	String	实例组UUID
count	int	实例组含有实例数量
serviceNameAlias	String	云服务中文名称
typeNameAlias	String	对象类型中午名称
regionAlias	String	区域中文名称
tagKey	String	实例组对应Tag，格式为：INSTANCEGROUP:

请求示例

DELETE   /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance-group/7900

响应示例

{
    "id": 7900,
    "name": "group_name_new",
    "serviceName": "BCE_BCC",
    "typeName": "Instance",
    "region": "bj",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "uuid": "5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
    "count": 0,
    "serviceNameAlias": null,
    "typeNameAlias": null,
    "regionAlias": null,
    "tagKey": "",
    "typeTarget": ""
}

获取实例组详情

请求结构体

Method: Get

Url： /csm/api/v1/userId/{userId}/instance-group/{id}

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	Path
id	Long	实例组Id	是	Path

响应参数

名称	类型	描述
id	Long	实例组Id
name	String	实例组名称
serviceName	String	云服务名称
typeName	String	对象类型
region	String	区域
userId	String	用户Id
uuid	String	实例组UUID
count	int	实例组含有实例数量
serviceNameAlias	String	云服务中文名称
typeNameAlias	String	对象类型中午名称
regionAlias	String	区域中文名称
tagKey	String	实例组对应Tag，格式为：INSTANCEGROUP:

请求示例

GET   /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance-group/7900

响应示例

{
    "id": 7900,
    "name": "group_name",
    "serviceName": "BCE_BCC",
    "typeName": "Instance",
    "region": "bj",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "uuid": "5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
    "count": 1,
    "serviceNameAlias": "云服务器BCC",
    "typeNameAlias": "云服务器BCC",
    "regionAlias": "北京",
    "tagKey": "INSTANCE_GROUP_5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx:5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
    "typeTarget": ""
}

查询实例组列表

请求结构体

Method: Get

Url： /csm/api/v1/userId/{userId}/instance-group/list

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	Path
name	String	实例组名称	否	Param
serviceName	String	云服务名称	否	Param
region	String	区域	否	Param
typeName	String	实例类型	否	Param
pageNo	int	页码数	是	Param
pageSize	int	每页返回数量	是	Param

请求示例

GET /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance-group/list?
name=group_name
&serviceName=BCE_BCC
&region=bj
&typeName=Instance
&pageNo=1
&pageSize=10

响应示例

{
    "orderBy": "",
    "order": "",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "result": [
        {
            "id": 7900,
            "name": "group_name",
            "serviceName": "BCE_BCC",
            "typeName": "Instance",
            "region": "bj",
            "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
            "uuid": "5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
            "count": 1,
            "serviceNameAlias": "云服务器BCC",
            "typeNameAlias": "云服务器BCC",
            "regionAlias": "北京",
            "tagKey": "INSTANCE_GROUP_5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx:5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
            "typeTarget": ""
        }
    ]
}

实例组添加实例成员

请求结构体

Method: Post

Url: /csm/api/v1/userId/{userId}/instance-group/{id}/instance/add

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	Path
id	Long	实例组Id	是	Path
mergedGroup	MergedGroup		是	requestBody

响应参数

名称	类型	描述
id	Long	实例组Id
name	String	实例组名称
serviceName	String	云服务名称
typeName	String	对象类型
region	String	区域
userId	String	用户Id
uuid	String	实例组UUID
count	int	实例组含有实例数量
serviceNameAlias	String	云服务中文名称
typeNameAlias	String	对象类型中午名称
regionAlias	String	区域中文名称
tagKey	String	实例组对应Tag，格式为：INSTANCEGROUP:

请求示例

POST   /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance-group/7900/instance/add

request Body
{
    "id": 7900,
    "name": "group_name",
    "region": "bj",
    "typeName": "Instance",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "resourceIdList": [
        {
            "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
            "region": "bj",
            "serviceName": "BCE_BCC",
            "typeName": "Instance",
            "resourceId": "InstanceId:dd0109a3-a7fe-4ffb-b2ae-3c6aa0bxxxxx"
        }
    ]
}

响应示例

响应说明，返回为实例组添加实例前的信息

{
    "id": 7900,
    "name": "group_name",
    "serviceName": "BCE_BCC",
    "typeName": "Instance",
    "region": "bj",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "uuid": "5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
    "count": 1,
    "serviceNameAlias": "云服务器BCC",
    "typeNameAlias": "云服务器BCC",
    "regionAlias": "北京",
    "tagKey": "INSTANCE_GROUP_5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx:5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
    "typeTarget": ""
}

获取实例组实例成员列表

请求结构体

Method: Get

Url: /csm/api/v1/userId/{userId}/instance-group/instance/list

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	Path
id	Long	实例Id	是	Param
serviceName	String	云服务名称	是	Param
typeName	String	对象类型	是	Param
region	String	区域	是	Param
viewType	ViewType(枚举类型)	查询实例列表表头时传参：LIST_VIEW，查询实例组成员列表表头时传参：DETAIL_VIEW	是	Param
pageNo	int	页码数	是	Param
pageSize	int	每页返回数量	是	Param

响应参数

名称	类型	描述
orderBy	String	排序字段
order	String	排序方式
pageNo	int	页码数
pageSize	int	每页返回数量
totalCount	int	实例组中实例数量
result	List<List>	实例组中实例信息

请求示例

GET    /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance-group/instance/list？
id=7900
&serviceName=BCE_BCC
&typeName=Instance
&region=bj
&viewType=DETAIL_VIEW
&pageNo=1
&pageSize=10

响应示例

{
    "orderBy": "",
    "order": "",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 2,
    "result": [
        [
            {
                "itemName": "id",
                "itemAlias": "实例id",
                "itemValue": "04b91096-a294-477d-bd11-1a7bcfxxxxx",
                "itemSeq": 2,
                "itemIdentitable": true,
                "itemDimension": "InstanceId",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "name",
                "itemAlias": "实例名称",
                "itemValue": "bcc_name",
                "itemSeq": 1,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "internalIp",
                "itemAlias": "内网ip",
                "itemValue": "192.168.xx.xx",
                "itemSeq": 2,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "publicIp",
                "itemAlias": "公网ip",
                "itemValue": "",
                "itemSeq": 4,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": false
            }
        ],
        [
            {
                "itemName": "id",
                "itemAlias": "实例id",
                "itemValue": "dd0109a3-a7fe-4ffb-b2ae-3c6aa0bxxxxx",
                "itemSeq": 2,
                "itemIdentitable": true,
                "itemDimension": "InstanceId",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "name",
                "itemAlias": "实例名称",
                "itemValue": "bcc_name_2",
                "itemSeq": 1,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "internalIp",
                "itemAlias": "内网ip",
                "itemValue": "192.168.xx.xx",
                "itemSeq": 2,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "publicIp",
                "itemAlias": "公网ip",
                "itemValue": "",
                "itemSeq": 4,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": false
            }
        ]
    ]
}

实例组移除实例成员

请求结构体

Method: Post

Url: /csm/api/v1/userId/{userId}/instance-group/{id}/instance/remove

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	Path
id	Long	实例组Id	是	Path
mergedGroup	MergedGroup		是	requestBody

响应参数

名称	类型	描述
id	Long	实例组Id
name	String	实例组名称
serviceName	String	云服务名称
typeName	String	对象类型
region	String	区域
userId	String	用户Id
uuid	String	实例组UUID
count	int	实例组含有实例数量
serviceNameAlias	String	云服务中文名称
typeNameAlias	String	对象类型中午名称
regionAlias	String	区域中文名称
tagKey	String	实例组对应Tag，格式为：INSTANCEGROUP:
typeTarget	String	对象类型所含有的维度内容

请求示例

POST  /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance-group/7900/instance/remove
  
  
request Body
{
    "id": 7900,
    "name": "group_name",
    "region": "bj",
    "typeName": "Instance",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "resourceIdList": [
        {
            "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
            "region": "bj",
            "serviceName": "BCE_BCC",
            "typeName": "Instance",
            "resourceId": "InstanceId:dd0109a3-a7fe-4ffb-b2ae-3c6aa0bxxxxx"
        }
    ]
}

响应示例

响应说明，返回为实例组移除实例前的信息

{
    "id": 7900,
    "name": "group_name",
    "serviceName": "BCE_BCC",
    "typeName": "Instance",
    "region": "bj",
    "userId": "a0d04d7c202140cb80155ff7b67xxxxx",
    "uuid": "5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
    "count": 2,
    "serviceNameAlias": "云服务器BCC",
    "typeNameAlias": "云服务器BCC",
    "regionAlias": "北京",
    "tagKey": "INSTANCE_GROUP_5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx:5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx",
    "typeTarget": ""
}

查看实例列表接口（创建实例组时用）

请求结构体

Method: Get

Url：/csm/api/v1/userId/{userId}/instance/list

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	Path
serviceName	String	云服务名称	是	Param
typeName	String	对象类型	是	Param
region	String	区域	是	Param
viewType	ViewType	查询实例列表时传参：LIST_VIEW 查询实例组成员列表时传参：DETAIL_VIEW	是	Param
pageNo	int	页码数	是	Param
pageSize	int	每页返回数量	是	Param
keywordType	String	模糊查询的属性	是	Param
keyword	String	模糊查询的值	是	Param

请求示例

GET /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance/list?
serviceName=BCE_BCC
&typeName=Instance
&region=bj
&viewType=LIST_VIEW
&pageNo=1
&pageSize=10
&keywordType=name
&keyword=

响应示例

{
    "orderBy": "",
    "order": "",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 58,
    "result": [
        [
            {
                "itemName": "name",
                "itemAlias": "实例名称",
                "itemValue": "bcc_name",
                "itemSeq": 1,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": true
            },
            {
                "itemName": "internalIp",
                "itemAlias": "内网ip",
                "itemValue": "192.168.xx.xx",
                "itemSeq": 3,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "id",
                "itemAlias": "实例id",
                "itemValue": "04b91096-a294-477d-bd11-1a7bcfbxxxxx",
                "itemSeq": 2,
                "itemIdentitable": true,
                "itemDimension": "InstanceId",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "shortId",
                "itemAlias": "实例短ID",
                "itemValue": "i-mPkxxxxx",
                "itemSeq": 4,
                "itemIdentitable": false,
                "itemDimension": "InstanceShortId",
                "itemIsConn": true,
                "itemView": false
            }
        ]
        ...
    ]
}

查看实例列表（用于对已经创建的实例组进行添加实例操作—过滤掉已经添加的实例）

请求结构体

Method: Get

Url：/csm/api/v1/userId/{userId}/instance/filteredList

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	Path
serviceName	String	云服务名称	是	Param
typeName	String	对象区域	是	Param
region	String	区域	是	Param
viewType	ViewType	查询实例列表时传参：LIST_VIEW 查询实例组成员列表时传参：DETAIL_VIEW	是	Param
pageNo	int	页码数	是	Param
pageSize	int	每页返回数量	是	Param
keywordType	String	模糊查询的属性	是	Param
keyword	String	模糊查询的值	是	Param
id	Long	实例组Id	是	Param
uuid	String	实例组唯一标识	是	Param

请求示例

GET   /csm/api/v1/userId/a0d04d7c202140cb80155ff7b67xxxxx/instance/filteredList
serviceName=BCE_BCC
&typeName=Instance
&region=bj
&viewType=LIST_VIEW
&pageNo=1
&pageSize=10
&keywordType=name
&keyword=
&id=7900
&uuid=5ac4bdcd-4ba5-46c8-b879-36f57f3xxxxx

响应示例

{
    "orderBy": "",
    "order": "",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 57,
    "result": [
        [
            {
                "itemName": "name",
                "itemAlias": "实例名称",
                "itemValue": "bcc_name_3",
                "itemSeq": 1,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": true
            },
            {
                "itemName": "internalIp",
                "itemAlias": "内网ip",
                "itemValue": "192.168.xx.xx",
                "itemSeq": 3,
                "itemIdentitable": false,
                "itemDimension": "",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "id",
                "itemAlias": "实例id",
                "itemValue": "dd0109a3-a7fe-4ffb-b2ae-3c6aa0bxxxxx",
                "itemSeq": 2,
                "itemIdentitable": true,
                "itemDimension": "InstanceId",
                "itemIsConn": true,
                "itemView": false
            },
            {
                "itemName": "shortId",
                "itemAlias": "实例短ID",
                "itemValue": "i-6nfxxxxx",
                "itemSeq": 4,
                "itemIdentitable": false,
                "itemDimension": "InstanceShortId",
                "itemIsConn": true,
                "itemView": false
            }
        ],
        ...
    ]
}

附录

MergedGroup

名称	类型	描述	是否必须
userId	String	用户Id	是
region	String	区域	是
serviceName	String	云服务名称	是
typeName	String	对象类型	是
name	String	实例组名称	是
resourceIdList	List < MonitorResource >	监控实例。添加实例时只填写新增实例信息。	是
typeTarget	String	eg：{"resourceType":"RD_ST_INSTANCE","resourceId":["ClusterId","NodeId"]}	否

MonitorResource

名称	类型	描述	是否必须
userId	String	用户Id	是
region	String	区域	是
serviceName	String	云服务名称	是
resourceId	String	实例Id，格式为：维度名称:维度ID	是
typeName	String	对象类型	是

InstanceGroupViewConfig

名称	类型	描述
itemName	String	属性名称
itemAlias	String	属性别称
itemValue	String	属性值
itemSeq	int	属性顺序
itemIdentitable	boolean	属性是否为实例属性
itemDimension	String	实例属性名称
itemIsConn	boolean	前端展示是否拼接
itemView	boolean	前端是否展示该属性

仪表盘接口

应用监控

云监控 BCM

实例组接口

创建实例组

请求结构体

请求参数

响应参数

请求示例

响应示例

更新实例组名称

请求结构体

请求参数

响应参数

请求示例

响应示例

删除实例组

请求结构体

请求参数

响应参数

请求示例

响应示例

获取实例组详情

请求结构体

请求参数

响应参数

请求示例

响应示例

查询实例组列表

请求结构体

请求参数

请求示例

响应示例

实例组添加实例成员

请求结构体

请求参数

响应参数

请求示例

响应示例

获取实例组实例成员列表

请求结构体

请求参数

响应参数

请求示例

响应示例

实例组移除实例成员

请求结构体

请求参数

响应参数

请求示例

响应示例

查看实例列表接口（创建实例组时用）

请求结构体

请求参数

请求示例

响应示例

查看实例列表（用于对已经创建的实例组进行添加实例操作—过滤掉已经添加的实例）

请求结构体

请求参数

请求示例

响应示例

附录

MergedGroup

MonitorResource

InstanceGroupViewConfig