调用DescribeSecurityGroups查询已创建的安全组的基本信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ens:DescribeSecurityGroups | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SecurityGroupId | string | 否 | 安全组 ID。 | sg-bp67acfmxazb4ph*** |
| PageNumber | integer | 否 | 安全组列表的页码。
| 1 |
| PageSize | integer | 否 | 分页查询时设置的每页行数。
| 10 |
| SecurityGroupName | string | 否 | 安全组名称。 | 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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | - |
| 400 | NoPermission | Permission denied. | 没有足够的权限，请联系云账号管理员授予您相应权限。 |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
| 400 | InvalidParameter | The errorMessage is %s. Please check it again. | - |
| 400 | InvalidSecurityGroupId.NotFound | The specified SecurityGroupId does not exist. | - |
| 400 | SecurityGroupRuleConflict.Duplicated | The SecurityGroup rule already exists. | - |
| 400 | AuthorizationLimitExceed | The limit of authorization records in the security group reaches. | - |
| 400 | SecurityGroupRule.NotFound | The input security group rule does not exist. | - |
| 400 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 当前操作不被支持，磁盘正在重置中。 |
| 400 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定实例不存在 |
| 400 | DependencyViolation | There is still instance(s) in the specified security group. | - |
| 400 | ens.interface.error | An error occurred while calling the API. | - |
| 400 | CallInterface | Call Interface Happen Error. | 接口调用出错。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-12-21 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |