DescribeSecurityGroups API for querying security groups - ENS

Queries details about created security groups.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeSecurityGroups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SecurityGroupId	string	No	The ID of the security group.	sg-bp67acfmxazb4ph***
SecurityGroupName	string	No	The name of the security group.	DocTest
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of returned pages.	49
SecurityGroups	object
SecurityGroup	array<object>	Details about security groups.
	array<object>
CreationTime	string	The creation time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2019-11-01T06:08:46Z
InstanceCount	integer	The number of associated instances.	5
Description	string	The description of the security group.	TestDescription
SecurityGroupId	string	The ID of the security group.	sg-bp67acfmxazb4ph***
SecurityGroupName	string	The name of the security group.	DocTest
InstanceIds	object
InstanceId	array	The IDs of the instances that are associated with the security group.
	string	The ID of instance.	i-5****
NetworkInterfaceIds	object
NetworkInterfaceId	array	The IDs of the ENIs that are associated with the security group.
	string	The ID of the ENI.	eni-5****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	ens.interface.error	Failed to call API.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.