接口功能介绍
查询用户安全组详情。
接口约束
无。
URI
GET /v4/vpc/describe-security-group-attribute
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 区域id | |
| securityGroupID | String | 是 | 安全组ID | |
| direction | String | 否 | 安全组规则授权方向：egress：安全组出方向ingress：安全组入方向all：不区分方向 默认是：all | all |
响应参数
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| statusCode | Integer | 800 | 返回状态码（800为成功，900为失败） |
| description | Integer | 返回信息说明，如果请求成功，返回空字符串；否则为错误信息 | |
| returnObj | Object | object | 返回结果 |
| errCode | String | SUCCESS | 错误描述 |
| message | String | success | 错误信息的英文描述 |
表 returnObj
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| securityGroupName | String | Default-Security-Group | 安全组名称 |
| id | String | 4fc90292-5ab4-59bb-xxxx-8b9410df41f5 | 安全组id |
| vmNum | String | 10 | 相关云主机 |
| origin | String | default | 企业项目 |
| vpcName | String | vpc-pm0628 | vpc名称 |
| vpcID | String | 86fff760-d78c-xxxx-8730-9c04c932eefd | 安全组所属的专有网络 |
| creationTime | String | 2022-06-28T12:19:43Z | 创建时间 |
| description | String | dasfsdf | 安全组描述信息 |
| securityGroupRuleList | object | object | 安全组规则信息 |
表 securityGroupRuleList
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| direction | String | egress | 出方向-egress、入方向-ingress |
| priority | Integer | 100 | 优先级:0~100 |
| ethertype | String | IPv4 | IP类型:IPv4、IPv6 |
| protocol | String | ANY | 协议: ANY、TCP、UDP、ICMP、ICMP6 |
| range | String | 20-30 | 接口范围/ICMP类型:1-65535 |
| destCidrIp | String | 0.0.0.0/0 | 远端地址:0.0.0.0/0 |
| description | String | 出方向 | 安全组规则描述信息。 |
| createTime | String | 2022-06-28T20:19:43Z | 创建时间，UTC时间。 |
| id | String | 6135ab21-84f6-xxxx-89aa-a654f01389d6 | 唯一标识ID |
| securityGroupID | String | 4fc90292-5ab4-59bb-xxxx-8b9410df41f5 | 安全组ID |
| action | String | accept | 拒绝策略:允许-accept 拒绝-drop |
请求示例
GET /v4/vpc/describe-security-group-attribute?regionID=xxx&securityGroupID=xxx
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": {
"securityGroupName": "李abcdefghijklmnopqrstu",
"id": "sg-la403pa2o0",
"vmNum": 0,
"origin": "0",
"vpcName": "vipvpc226",
"vpcID": "vpc-jp2dz964u8",
"creationTime": "2022-10-03T07:11:52Z",
"description": "李abcdefghijklmnopqrstuvwxyz012345678",
"securityGroupRuleList": [
{
"direction": "ingress",
"priority": 11,
"ethertype": "IPv4",
"protocol": "UDP",
"range": "1000",
"destCidrIp": "1.1.1.128/25",
"description": "test ingress",
"origin": "user",
"createTime": "2022-10-03T15:21:49Z",
"id": "sgrule-bhjgzxc6ly",
"action": "accept",
"securityGroupID": "sg-la403pa2o0"
}
]
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
