接口功能介绍
该接口提供用户查询用户安全组详情的功能
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
保证安全组ID存在
URI
GET /v4/ecs/vpc/describe-security-group-attribute
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| securityGroupID | 是 | String | 安全组ID，您可以查看安全组概述了解安全组相关信息 获取： 查 查询用户安全组列表 创 创建安全组 |
sg-8hikg37xjs | |
| projectID | 否 | String | 企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目 | 0 | |
| direction | 否 | String | 安全组规则授权方向，取值范围： egress（出方向）， ingress（入方向）， all（不区分方向） 注：默认值为all |
all |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| description | String | 失败时的错误描述，一般为中文描述。 | 成功 | |
| returnObj | Object | 返回结果 | returnObj | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 错误信息的英文描述 | success |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroupName | String | 安全组名称 | Default-Security-Group | |
| id | String | 安全组id | sg-8hikg37xjs | |
| vmNum | Integer | 相关云主机 | 10 | |
| origin | String | 表示是否是默认安全组 | 0 | |
| vpcName | String | vpc名称 | vpc-pm0628 | |
| vpcID | String | 安全组所属的专有网络 | 86fff760-d78c-xxxx-8730-9c04c932eefd | |
| creationTime | String | 创建时间 | 2022-06-28T12:19:43Z | |
| description | String | 安全组描述信息 | dasfsdf | |
| securityGroupRuleList | Array of Objects | 安全组规则信息 | securityGroupRuleList |
表 securityGroupRuleList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| direction | String | 出方向-egress、入方向-ingress | egress | |
| action | String | 拒绝策略:允许-accept 拒绝-drop | accept | |
| origin | String | 来源 | user | |
| 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 |
枚举参数
无
请求示例
请求url
示例1：查询指定安全组的详情华东1查询指定安全组的信息GET
{endpoint}/v4/ecs/vpc/describe-security-group-attribute?regionID=bb9fdb42056f11eda1610242ac110002&securityGroupID=sg-la403pa2o0
请求头header
无
请求体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"
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
