实例组接口
创建实例组
请求结构体
Method: Post
Url: /csm/api/v1/userId/{userId}/instance-group
请求参数
名称 | 类型 | 描述 | 是都必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query参数 |
mergedGroup | MergedGroup | 是 | requestBody参数 |
MergedGroup
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
region | String | 区域 | 是 |
serviceName | String | 云服务名称 | 是 |
typeName | String | 对象类型 | 是 |
name | String | 实例组名称 | 是 |
resourceIdList | List < MonitorResource > | 监控实例 | 是 |
MonitorResource
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
region | String | 区域 | 是 |
serviceName | String | 云服务名称 | 是 |
resourceId | String | 实例Id | 是 |
typeName | String | 对象类型 | 是 |
请求示例
POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance-group
request body:
{
"name":"test_lzp02",
"region":"bj",
"typeName":"Instance",
"serviceName":"BCE_CDN",
"userId":"453bf9588c9e488f9ba2c984129090dc",
"resourceIdList":[
{
"userId":"453bf9588c9e488f9ba2c984129090dc",
"region":"bj",
"serviceName":"BCE_CDN",
"typeName":"Instance",
"resourceId":"DomainId:bcm5-qasandbox.sys-qa.com"
}
]
}
响应示例
{
"id": 863,
"name": "test_lzp02",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "68d8e352-0ce6-4178-8eee-5ba5da39d4e8",
"count": 0,
"serviceNameAlias": null,
"typeNameAlias": null,
"regionAlias": null,
"tagKey": ""
}
删除实例组
请求结构体
Method: Delete
Url: /csm/api/v1/userId/{userId}/instance-group/{id}
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
id | Long | 实例组Id | 是 | Query |
请求示例
DELETE /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance-group/863
响应示例
{
"id": 863,
"name": "test_lzp02",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "68d8e352-0ce6-4178-8eee-5ba5da39d4e8",
"count": 0,
"serviceNameAlias": null,
"typeNameAlias": null,
"regionAlias": null,
"tagKey": ""
}
获取实例组详情
请求结构体
Method: Get
Url: /csm/api/v1/userId/{userId}/instance-group/{id}
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
id | Long | 实例组Id | 是 | Query |
请求示例
GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance-group/864
响应示例
{
"id": 864,
"name": "test_lzp02",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "84e102b6-e483-4f1c-b868-ca1e430b1a92",
"count": 1,
"serviceNameAlias": "内容分发网络CDN",
"typeNameAlias": "内容分发网络",
"regionAlias": "全局",
"tagKey": "INSTANCE_GROUP_84e102b6-e483-4f1c-b868-ca1e430b1a92:84e102b6-e483-4f1c-b868-ca1e430b1a92"
}
实例组添加实例成员
请求结构体
Method: Post
Url: /csm/api/v1/userId/{userId}/instance-group/{id}/instance/add
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
id | Long | 实例组Id | 是 | Query |
mergedGroup | MergedGroup | 是 | requestBody |
MergredGroup
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
region | String | 区域 | 是 |
serviceName | String | 云服务名称 | 是 |
typeName | String | 对象类型 | 是 |
name | String | 实例组名称 | 是 |
resourceIdList | List< monitorResource > | 监控实例 | 是 |
MonitorResource
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
region | String | 区域 | 是 |
serviceName | String | 云服务名称 | 是 |
resourceId | String | 实例Id | 是 |
typeName | String | 对象类型 | 是 |
请求示例
POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance-group/864/instance/add
request Body
{
"id":864,
"name":"test_lzp02",
"region":"bj",
"typeName":"Instance",
"userId":"453bf9588c9e488f9ba2c984129090dc",
"resourceIdList":[
{
"userId":"453bf9588c9e488f9ba2c984129090dc",
"region":"bj",
"serviceName":"BCE_CDN",
"typeName":"Instance",
"resourceId":"DomainId:126.com.cname.qasandbox.sys-qa.com"
},
{
"userId":"453bf9588c9e488f9ba2c984129090dc",
"region":"bj",
"serviceName":"BCE_CDN",
"typeName":"Instance",
"resourceId":"DomainId:bcm5-qasandbox.sys-qa.com"
}
]
}
响应示例
响应说明,返回为实例组添加实例前的信息
{
"id": 864,
"name": "test_lzp02",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "84e102b6-e483-4f1c-b868-ca1e430b1a92",
"count": 0,
"serviceNameAlias": "内容分发网络CDN",
"typeNameAlias": "内容分发网络",
"regionAlias": "全局",
"tagKey": "INSTANCE_GROUP_84e102b6-e483-4f1c-b868-ca1e430b1a92:84e102b6-e483-4f1c-b868-ca1e430b1a92"
}
获取实例组实例成员列表
请求结构体
Method: Get
Url: /csm/api/v1/userId/{userId}/instance-group/instance/list
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
id | Long | 实例Id | 是 | |
serviceName | String | 云服务名称 | 是 | Query |
typeName | String | 对象类型 | 是 | Query |
region | String | 区域 | 是 | Query |
viewType | ViewType(枚举类型) | 查询实例列表表头时传参:LIST_VIEW, 查询实例组成员列表表头时传参:DETAIL_VIEW |
是 | Query |
pageNo | int | 是 | Query | |
pageSize | int | 是 | Query |
请求示例
GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance-group/instance/list?
id=864&
pageSize=2&
pageNo=1&
serviceName=BCE_BMR&
userId=a0d04d7c202140cb80155ff7b6752ce4&
typeName=Service&
region=bj&
viewType=DETAIL_VIEW
响应示例
{
"orderBy": "",
"order": "",
"pageNo": 1,
"pageSize": 2,
"totalCount": 2,
"result": [
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "126.com.cname.qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "地域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
},
{
"itemName": "cname",
"itemAlias": "CNAME域名",
"itemValue": "126.com.cname.qasandbox.sys-qa.com.cname.qasandbox.sys-qa.com",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
},
{
"itemName": "formType",
"itemAlias": "业务类型",
"itemValue": "图片小文件加速",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm5-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "地域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
},
{
"itemName": "cname",
"itemAlias": "CNAME域名",
"itemValue": "bcm5-qasandbox.sys-qa.com.cname.qasandbox.sys-qa.com",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
},
{
"itemName": "formType",
"itemAlias": "业务类型",
"itemValue": "通用默认类型",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
]
]
}
实例组移除实例成员
请求结构体
Method: Post
Url: /csm/api/v1/userId/{userId}/instance-group/{id}/instance/remove
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
id | Long | 实例组Id | 是 | Query |
mergedGroup | MergedGroup | 是 | requestBody |
MergredGroup
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
region | String | 区域 | 是 |
serviceName | String | 云服务名称 | 是 |
typeName | String | 对象类型 | 是 |
name | String | 实例组名称 | 是 |
resourceIdList | List< monitorResource > | 监控实例 | 是 |
MonitorResource
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
region | String | 区域 | 是 |
serviceName | String | 云服务名称 | 是 |
resourceId | String | 实例Id | 是 |
typeName | String | 对象类型 | 是 |
请求示例
POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance-group/864/instance/remove
request Body
{
"id":864,
"name":"test_lzp02",
"region":"bj",
"serviceName":"BCE_CND",
"userId":"453bf9588c9e488f9ba2c984129090dc",
"typeName":"Instance",
"resourceIdList":[
{
"resourceId":"DomainId:126.com.cname.qasandbox.sys-qa.com",
"userId":"453bf9588c9e488f9ba2c984129090dc",
"region":"bj",
"serviceName":"BCE_CDN",
"typeName":"Instance"
},
{
"resourceId":"DomainId:bcm5-qasandbox.sys-qa.com",
"userId":"453bf9588c9e488f9ba2c984129090dc",
"region":"bj",
"serviceName":"BCE_CND",
"typeName":"Instance"
}
]
}
响应示例
响应说明,返回为实例组移除实例前的信息
{
"id": 864,
"name": "test_lzp02",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "84e102b6-e483-4f1c-b868-ca1e430b1a92",
"count": 2,
"serviceNameAlias": "内容分发网络CDN",
"typeNameAlias": "内容分发网络",
"regionAlias": "全局",
"tagKey": "INSTANCE_GROUP_84e102b6-e483-4f1c-b868-ca1e430b1a92:84e102b6-e483-4f1c-b868-ca1e430b1a92"
}
查询实例组列表
请求结构体
Method: Get
Url: /csm/api/v1/userId/{userId}/instance-group/list
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
serviceName | Strindg | 云服务名称 | 是 | Query |
region | String | 区域 | 否 | Query |
pageNo | int | 是 | Query | |
pageSize | int | 是 | Query |
请求示例
GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance-group/list?
pageSize=5&
pageNo=1&
serviceName=BCE_CDN
响应示例
{
"orderBy": "",
"order": "",
"pageNo": 1,
"pageSize": 5,
"totalCount": 83,
"result": [
{
"id": 864,
"name": "test_lzp02",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "84e102b6-e483-4f1c-b868-ca1e430b1a92",
"count": 0,
"serviceNameAlias": "内容分发网络CDN",
"typeNameAlias": "内容分发网络",
"regionAlias": "全局",
"tagKey": "INSTANCE_GROUP_84e102b6-e483-4f1c-b868-ca1e430b1a92:84e102b6-e483-4f1c-b868-ca1e430b1a92"
},
{
"id": 860,
"name": "test_lzp1",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "dcc0fea5-d303-4c70-9e57-8b0cbd2dc5ce",
"count": 1,
"serviceNameAlias": "内容分发网络CDN",
"typeNameAlias": "内容分发网络",
"regionAlias": "全局",
"tagKey": "INSTANCE_GROUP_dcc0fea5-d303-4c70-9e57-8b0cbd2dc5ce:dcc0fea5-d303-4c70-9e57-8b0cbd2dc5ce"
},
{
"id": 847,
"name": "cdn_instanceGroup_bihuan",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "6eb99ccc-0bac-4324-841d-c654c9802f34",
"count": 2,
"serviceNameAlias": "内容分发网络CDN",
"typeNameAlias": "内容分发网络",
"regionAlias": "全局",
"tagKey": "INSTANCE_GROUP_6eb99ccc-0bac-4324-841d-c654c9802f34:6eb99ccc-0bac-4324-841d-c654c9802f34"
},
{
"id": 816,
"name": "test-real",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "5d084ad0-bab6-4961-b86a-4ae6a120bf26",
"count": 1,
"serviceNameAlias": "内容分发网络CDN",
"typeNameAlias": "内容分发网络",
"regionAlias": "全局",
"tagKey": "INSTANCE_GROUP_5d084ad0-bab6-4961-b86a-4ae6a120bf26:5d084ad0-bab6-4961-b86a-4ae6a120bf26"
},
{
"id": 813,
"name": "cdn_instancegROUP_repeat",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "67652a2a-0809-4392-85da-ce2a206a8cce",
"count": 1,
"serviceNameAlias": "内容分发网络CDN",
"typeNameAlias": "内容分发网络",
"regionAlias": "全局",
"tagKey": "INSTANCE_GROUP_67652a2a-0809-4392-85da-ce2a206a8cce:67652a2a-0809-4392-85da-ce2a206a8cce"
}
]
}
更新实例组名称
请求结构体
Method: Patch
Url:/csm/api/v1/userId/{userId}/instance-group
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
group | Group | 实例组信息 | 是 | requestBody |
Group
名称 | 类型 | 说明 | 是否必须 |
---|---|---|---|
id | Long | 实例组Id | 是 |
name | String | 更新后实例组名称 | 是 |
serviceName | String | 云服务名称 | 是 |
typeName | String | 对象类型,如实例、集群 | 是 |
region | String | 区域 | 是 |
userId | Strng | 用户Id | 否 |
请求示例
PATCH /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance-group
request Body
{
"id":864,
"name":"test_lzp03",
"region":"bj",
"serviceName":"BCE_CDN",
"typeName":"Instance",
"userId":"453bf9588c9e488f9ba2c984129090dc"
}
响应示例
{
"id": 864,
"name": "test_lzp03",
"serviceName": "BCE_CDN",
"typeName": "Instance",
"region": "bj",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"uuid": "84e102b6-e483-4f1c-b868-ca1e430b1a92",
"count": 0,
"serviceNameAlias": null,
"typeNameAlias": null,
"regionAlias": null,
"tagKey": ""
}
查看实例列表接口(创建实例组时用)
请求结构体
Method: Get
Url:/csm/api/v1/userId/{userId}/instance/list
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
serviceName | String | 云服务名称 | 是 | Query |
typeName | String | 对象类型 | 是 | Query |
region | String | 区域 | 是 | Query |
viewType | ViewType | 查询实例列表表头时传参:LIST_VIEW 查询实例组成员列表表头时传参:DETAIL_VIEW |
是 | Query |
pageNo | int | 是 | Query | |
pageSize | int | 是 | Query | |
keywordType | String | 进行模糊查询的类型 | 是 | Query |
keyword | String | 模糊查询的值 | 是 | Query |
请求示例
GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance/list?
pageSize=5&
pageNo=1&
userId=453bf9588c9e488f9ba2c984129090dc&
serviceName=BCE_CDN&
typeName=Instance&
viewType=LIST_VIEW&
keywordType=instanceName&
keyword=&
region=bj
响应示例
{
"orderBy": "",
"order": "",
"pageNo": 1,
"pageSize": 5,
"totalCount": 14,
"result": [
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm5-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm3-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm2-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm1-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
]
]
}
查看实例列表(用于对已经创建的实例组进行添加实例操作—过滤掉已经添加的实例)
请求结构体
Method: Get
Url:/csm/api/v1/userId/{userId}/instance/filteredList
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
serviceName | String | 云服务名称 | 是 | Query |
typeName | String | 对象区域 | 是 | Query |
region | String | 区域 | 是 | |
viewType | ViewType | 查询实例列表表头时传参:LIST_VIEW 查询实例组成员列表表头时传参:DETAIL_VIEW |
是 | Query |
pageNo | int | 是 | Query | |
pageSize | int | 是 | Query | |
keywordType | String | 模糊查询的类型 | 是 | Query |
keyword | String | 模糊查询的值 | 是 | Query |
id | Long | 实例组Id | 是 | Query |
uuid | String | 实例组唯一标识 | 是 | Query |
请求示例
GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/instance/filteredList?
pageSize=5&
pageNo=1&
userId=453bf9588c9e488f9ba2c984129090dc&
serviceName=BCE_CDN&
typeName=Instance&
viewType=LIST_VIEW&
keywordType=instance&
keyword=&
region=bj&
id=864&
uuid=84e102b6-e483-4f1c-b868-ca1e430b1a92
响应示例
{
"orderBy": "",
"order": "",
"pageNo": 1,
"pageSize": 5,
"totalCount": 14,
"result": [
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm5-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm3-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm2-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm1-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
],
[
{
"itemName": "domain",
"itemAlias": "域名",
"itemValue": "bcm-qasandbox.sys-qa.com",
"itemSeq": 1,
"itemIdentitable": true,
"itemDimension": "DomainId",
"itemIsConn": true
},
{
"itemName": "region",
"itemAlias": "区域",
"itemValue": "bj",
"itemSeq": 2,
"itemIdentitable": false,
"itemDimension": "",
"itemIsConn": false
}
]
]
}