tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSecurityGroups

Last updated: 2023-08-18 14:27:59

1. API Description

Domain name for API request: ecm.tencentcloudapi.com.

This API is used to view a security group.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeSecurityGroups.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
SecurityGroupIds.N No Array of String Security group instance ID, such as esg-33ocnj9n, which can be obtained through DescribeSecurityGroups. Each request supports a maximum of 100 instances. SecurityGroupIds and Filters cannot be specified at the same time.
Filters.N No Array of Filter Filter. SecurityGroupIds and Filters cannot be specified at the same time.
security-group-id - String - (Filter) Security group ID.
security-group-name - String - (Filter) Security group name.
tag-key - String - Required: no - (Filter) Filter by tag key.
tag:tag-key - String - Required: no - (Filter) Filter by tag key-value pair. Replace tag-key with the specific tag key.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of results to be returned. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible instances.
SecurityGroupSet Array of SecurityGroup Security group object.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Viewing security group

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeSecurityGroups
&Limit=1
&Filters.0.Name=security-group-id
&Filters.0.Values.0=esg-05bb4upy
&Filters.1.Name=security-group-name
&Filters.1.Values.0=TestGroup
&<Common request parameters>

Output Example

{
    "Response": {
        "SecurityGroupSet": [
            {
                "SecurityGroupId": "esg-05bb4upy",
                "SecurityGroupName": "TestGroup",
                "SecurityGroupDesc": "test-group-desc",
                "IsDefault": "true",
                "TagSet": []
            }
        ],
        "TotalCount": 1,
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.UnauthorizedOperation Authentication failed.
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter The parameter is incorrect.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.Malformed The input parameter format is invalid.
MissingParameter The parameter is missing.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy