备案 控制台 登录 注册
文档中心 > DescribeSecurityGroup
DescribeSecurityGroup

最近更新时间：2021-12-24

请求方法：GET

接口描述： 查询您创建的安全组的列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

是

系统规定参数。取值：DescribeSecurityGroup

RegionId

String

是

地域ID。
  HB1-BJMY （华北2-北京2） ；
  HD1-SHMY（华东1-上海）

SgId

String

否

安全组ID。

Name

String

否

安全组名称。

Description

String

否

安全组描述。

Page

String

否

页码。

Size

String

否

大小。


返回参数

名称

类型

描述

RequestId

String

请求 ID。无论调用接口成功与否，我们都会返回请求 ID。

Code

String

请求结果编码。

Msg

String

请求结果描述。

Res

Object


+Page

Integer

页码。

+Data

Array

安全组列表数组。

++Status

String

安全组状态。

++RegionId

String

地域ID。

++InstanceNum

Integer

序列号。

++InstanceCode

String

安全组规格。

++InstanceId

String

安全组ID。

++Description

String

安全组描述。

++InstanceName

String

安全组名称。

++UserId

String

用户ID。

+Size

Integer

安全组个数。

+Total

Integer

安全组总个数。


示例

请求示例

GET https://api.unicloud.com/networks/securitygroup?Action=DescribeSecurityGroup

&RegionId=cn-beijing

&<公共请求参数>

返回示例

JSON 格式

{

    "Code": "Network.Success",

    "Msg": "获取安全组列表成功",

    "Res": {

        "Page": 1,

        "Data": [

            {

                "Status": "RUNNING",

                "RegionId": "cn-beijing",

                "InstanceNum": 0,

                "InstanceCode": "SecurityGroup.normal",

                "InstanceId": "sg-d75ti277372ob",

                "Description": "new sg",

                "InstanceName": "MySecurityGroup",

                "UserId": "de3d55a8-f822-461e-8133-52375100ad87"

            },

            {

                "Status": "RUNNING",

                "RegionId": "cn-beijing",

                "InstanceNum": 1,

                "InstanceCode": "SecurityGroup.normal",

                "InstanceId": "sg-jx3zoi3554zob",

                "Description": "",

                "InstanceName": "rfsdf",

                "UserId": "de3d55a8-f822-461e-8133-52375100ad87"

            }

        ],

        "Size": 2,

        "Total": 2

    },

    "RequestId": "6fac0c11-217d-4243-a2f3-28e05f891e55"

}