虚拟私有云
安全组规则详情
接口功能介绍
查询安全组规则详情。
接口约束
URI
GET /v4/vpc/describe-security-group-rule
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 区域id | |
| securityGroupID | 是 | String | 安全组 ID | |
| securityGroupRuleID | 是 | String | 安全组规则 ID |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| direction | String | 出方向-egress、入方向-ingress | egress |
| priority | Integer | 优先级:0~100 | 100 |
| ethertype | String | IP类型:IPv4、IPv6 | IPv4 |
| protocol | String | 协议: ANY、TCP、UDP、ICMP、ICMP6 | ANY |
| range | String | 接口范围/ICMP类型:1-65535 | 20-30 |
| destCidrIp | String | 远端地址:0.0.0.0/0 | 0.0.0.0/0 |
| description | String | 安全组规则描述信息。 | 出方向 |
| createTime | String | 创建时间，UTC时间。 | 2022-06-28T20:19:43Z |
| id | String | 唯一标识ID | 6135ab21-84f6-xxxx-89aa-a654f01389d6 |
| securityGroupID | String | 安全组ID | 4fc90292-5ab4-59bb-xxxx-8b9410df41f5 |
| action | String | 否 | 拒绝策略:允许-accept 拒绝-drop |
请求示例
请求url
GET /v4/vpc/describe-security-group-rule?regionID=xxx&securityGroupID=sg-xxx&securityGroupRuleID=sgrule-xxxx
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"direction": "egress",
"priority": 100,
"ethertype": "IPv4",
"protocol": "ANY",
"range": "1-65535",
"destCidrIp": "0.0.0.0/0",
"description": "",
"origin": "user",
"createTime": "2022-10-11T14:53:52Z",
"id": "sgrule-g2v16hdklm",
"action": "accept",
"securityGroupID": "sg-8hikg37xjs"
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
