接口功能介绍
查询安全组绑定云服务器列表
接口约束
无
URI
GET /v4/vpc/get-sg-associate-vms
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 区域id | 81f7728662dd11ec810800155d307d5b |
| securityGroupID | String | 是 | 安全组ID | sg-la403pa2o0 |
| projectID | String | 否 | 企业项目 ID，默认为"0" | 0 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| pageSize | Integer | 否 | 分页查询时每页的行数，最大值为 50，默认值为 10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Object | 返回结果 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| results | Array of Objects | 业务数据 | 见下表 |
| totalCount | Integer | 列表条目数 | 20 |
| currentCount | Integer | 分页查询时每页的行数。 | 4 |
| totalPage | Integer | 总页数 | 5 |
表 results
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| instanceID | String | 主机 ID | ss-x-xx-ss |
| instanceName | String | 主机名 | test |
| instanceType | String | 主机类型：VM / BM | VM |
| instanceState | String | 主机状态 | ACTIVE |
| privateIp | String | 私有 ipv4 | 192.168.0.1 |
| privateIpv6 | String | 私有 ipv6 |
请求示例
GET /v4/vpc/get-sg-associate-vms?regionID=xxx&securityGroupID=xxx
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"results": [
{
"instanceID": "test",
"instanceName": "test",
"instanceType": "VM",
"instanceState": "ACTIVE",
"privateIp": "192.168.0.1",
"privateIpv6": ""
}
],
"totalCount": 1,
"totalPage": 1,
"currentCount": 1
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
