DescribeSecurityGroups

DescribeSecurityGroups

1. 接口描述

本接口用于查询一个或多个指定安全组的信息。用户可以根据安全组ID、安全组名称等信息来搜索安全组信息。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
securityGroupIds	否	Array of String	安全组ID。 取值可以由多个安全组ID组成一个。最多支持100个ID查询。
securityGroupName	否	String	安全组名称。
pageSize	否	Integer	返回的分页大小。 默认为20，最大为1000。
pageNum	否	Integer	返回的分页数。 默认为1。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
dataSet	Array of SecurityGroupInfo	安全组结果集。
totalCount	Integer	符合条件的数据总数。

4. 代码示例

示例

1. 获取所有安全组。

不带任何参数查询所有的安全组。

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeSecurityGroups
<Common Request Params>

Request:
{
  "securityGroupIds": null,
  "securityGroupName": null,
  "pageSize": 5,
  "pageNum": 1
}

Response:
{
  "requestId": "T7977AF93-01C3-4862-A178-03953A4901C3",
  "response": {
    "requestId": "T7977AF93-01C3-4862-A178-03953A4901C3",
    "dataSet": [
      {
        "securityGroupId": "your-sucerity-id",
        "securityGroupName": "123",
        "securityGroupStatus": "Available",
        "createTime": "2022-01-01T01:00:00Z",
        "description": null,
        "instanceIds": [
          "your-instance-id"
        ],
        "ruleInfos": [
          {
            "ruleId": 120,
            "direction": "ingress",
            "policy": "drop",
            "ipProtocol": "all",
            "portRange": "-1/-1",
            "cidrIp": "0.0.0.0/0"
          },
          {
            "ruleId": 124,
            "direction": "ingress",
            "policy": "accept",
            "ipProtocol": "tcp",
            "portRange": "80/80",
            "cidrIp": "0.0.0.0/0"
          }
        ]，
        "isDefault": true
      }
    ],
    "totalCount": 1
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明