All Products
Search
Document Center

ENS:DescribeSecurityGroups

Last Updated:Mar 14, 2025

Queries details about created security groups.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeSecurityGroupslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SecurityGroupIdstringNo

The ID of the security group.

sg-bp67acfmxazb4ph***
SecurityGroupNamestringNo

The name of the security group.

DocTest
PageSizeintegerNo

The number of entries per page.

  • Maximum value: 50.
  • Default value: 10
10
PageNumberintegerNo

The page number.

  • Pages start from page 1.
  • Default value: 1
1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The number of entries per page.

10
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of returned pages.

49
SecurityGroupsarray<object>

Details about security groups.

SecurityGroupobject
CreationTimestring

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
InstanceCountinteger

The number of associated instances.

5
Descriptionstring

The description of the security group.

TestDescription
SecurityGroupIdstring

The ID of the security group.

sg-bp67acfmxazb4ph***
SecurityGroupNamestring

The name of the security group.

DocTest
InstanceIdsarray

The list of instance IDs.

InstanceIdstring

The IDs of instances on which you want to deploy SDGs. You can deploy SDGs on a maximum of 100 instances at a time.

i-5****
NetworkInterfaceIdsarray

The IDs of ENIs.

NetworkInterfaceIdstring

The IDs of elastic network interfaces (ENIs).

eni-5****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400NoPermissionPermission denied.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.
400ens.interface.errorFailed to call API.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-01-02The API operation is not deprecated.. The Error code has changed. The response structure of the API has changedView Change Details
2023-12-21API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details