接口功能介绍
查询物理机指定网卡的安全组信息
接口约束
无
URI
GET /v4/ebm/instance_interface_security_group_list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 是 | String | 可用区名称或者 default。您可以调用 https://www.ctyun.cn/document/10026730/10040590 获取资源池信息，查询结果中zoneList内返回可用区名称，若查询结果中zoneList为空，即为单可用区，本字段填写default | az1 | |
| instanceUUID | 是 | String | 实例UUID | ss-vukvrtktafkyovqojz811e3izvhc | |
| interfaceUUID | 是 | String | 该实例的网卡UUID | ss-vukvrtktafkyovqojz811e3izvhc |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.SecurityGroupList.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Object | 返回参数，参考表returnObj | {} | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroups | Array of Objects | 安全组信息列表 | securityGroups |
表securityGroups
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroupID | String | 安全组UUID | sg-wn2kibtlbd | |
| securityGroupName | String | 安全组名称 | sgs-740e |
请求示例
Query
/openapi/v4/ebm/instance_interface_security_group_list?regionID=81f7728662dd11ec810800155d307d5b&azName=az2&instanceUUID=ss-vukvrtktafkyovqojz811e3izvhc&interfaceUUID=ss-vukvrtktafkyovqojz811e3izvhc
响应示例
{
"returnObj":
{
"securityGroups":
[{"securityGroupID": "sg-wn2kibtlbd",
"securityGroupName": "sgs -740e "},
{"securityGroupID ": "sg - vakdle978c ",
"securityGroupName ": "Default - Security - Group "}]
},
"statusCode ": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.SecurityGroupList.NotValid | 请求参数非法 |
| Ebm.Instance.NotFound | 物理机不存在 |
| Ebm.InterfaceList.NotFound | 网卡不存在 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
