1)接口功能介绍
查询单个安全组。
2)接口约束
确保请求securityGroupId的存在。
3)URI
GET /v1/describeSecurityGroupAttribute。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
securityGroupId | 是 | String | 安全组ID | 12 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
securityGroupId | 是 | String | 安全组ID | 12 | |
securityGroupName | 是 | String | 安全组名称 | test | |
description | 是 | String | 安全组描述 | ttttttt | |
created | 是 | String | 安全组创建时间(Unix时间戳,秒) | 1610327761 | |
updated | 是 | String | 安全组更新时间(Unix时间戳,秒) | 1610334171 | |
default | 是 | Boolean | 是否默认 | false | |
ingresses | 是 | List | 入方向规则列表 | * | item |
egresses | 是 | List | 出方向规则列表 | * | item |
表 item
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sourceType | 是 | String | 来源类型,目前只支持IP。 | IP | |
address | 是 | String | IP地址(段、组) | "0.0.0.0/0" | |
protocolType | 是 | String | 协议类型,目前支持ALL(全部)、ICMP、GRE、TCP、UDP 五类。 | UDP | |
ports | 是 | String | 端口号,当协议类型为ALL、ICMP、GRE时,端口为全部端口,取默认值0,可不指定该参数;当协议类型为TCP、UDP时,必须指定1-65535范围内的端口号列表,逗号分隔 | 3389 | |
policyType | 是 | String | 策略,可选类型为ACCEPT、DROP两种。 | ACCEPT | |
description | 否 | String | 描述 | egress-sdddd | |
securityGroupId | 否 | String | 安全组ID | 12 | |
priority | 否 | Integer | 优先级 | 85 |
6)请求示例
GET "http://{host}/v1/describeSecurityGroupAttribute?securityGroupId=1953"
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"updated": "1670068584",
"ingresses": [
{
"sourceType": "IP",
"protocolType": "ALL",
"securityGroupId": "1953",
"priority": 0,
"policyType": "DROP",
"address": "0.0.0.0/1",
"ports": "0",
"description": "入方向"
}
],
"description": "updatetest",
"created": "1670065931",
"default": false,
"securityGroupId": "1953",
"securityGroupName": "",
"egresses": [
{
"sourceType": "IP",
"protocolType": "ALL",
"securityGroupId": "1953",
"priority": 0,
"policyType": "ACCEPT",
"address": "0.0.0.0/0",
"ports": "0",
"description": "出方向"
}
]
},
"requestId": "d15e1bb4-e6b2-419f-b2e0-6ae74ff7e350"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |