文档

DescribeSecurityGroups - 查询安全组信息

更新时间:

调用DescribeSecurityGroups查询已创建的安全组的基本信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DescribeSecurityGroupsRead
  • acs:ens::{#accountId}:*

请求参数

名称类型必填描述示例值
SecurityGroupIdstring

安全组 ID。

sg-bp67acfmxazb4ph***
PageNumberinteger

安全组列表的页码。

  • 起始值:1。
  • 默认值:1。
1
PageSizeinteger

分页查询时设置的每页行数。

  • 最大值:50。
  • 默认值:10。
10
SecurityGroupNamestring

安全组名称。

DocTest

返回参数

名称类型描述示例值
object
PageSizeinteger

分页查询时设置的每页行数。

10
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

安全组列表的页码。

1
TotalCountinteger

分页查询时分页总页数。

49
SecurityGroupsobject []

安全组。

CreationTimestring

创建时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为 yyyy-MM-ddTHH:mm:ssZ。

2019-11-01T06:08:46Z
InstanceCountinteger

关联实例数量。

5
Descriptionstring

安全组描述信息。

TestDescription
SecurityGroupIdstring

安全组 ID。

sg-bp67acfmxazb4ph***
SecurityGroupNamestring

安全组名称。

DocTest

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 49,
  "SecurityGroups": {
    "SecurityGroup": [
      {
        "CreationTime": "2019-11-01T06:08:46Z",
        "InstanceCount": 5,
        "Description": "TestDescription",
        "SecurityGroupId": "sg-bp67acfmxazb4ph***",
        "SecurityGroupName": "DocTest"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.-
400SecurityGroupRuleConflict.DuplicatedThe SecurityGroup rule already exists.-
400AuthorizationLimitExceedThe limit of authorization records in the security group reaches.-
400SecurityGroupRule.NotFoundThe input security group rule does not exist.-
400IncorrectInstanceStatusThe current status of the resource does not support this operation.当前操作不被支持,磁盘正在重置中。
400InvalidInstanceId.NotFoundThe specified InstanceId does not exist.-
400DependencyViolationThere is still instance(s) in the specified security group.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.接口调用出错。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-21OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
入参OpenAPI 入参发生变更
    删除入参:Version
  • 本页导读 (1)
文档反馈