Domain name for API request: cfw.tencentcloudapi.com.
This API is used to get the security group rule list.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeSecurityGroupList. |
Version | Yes | String | Common Params. The value used for this API: 2019-09-04. |
Region | No | String | Common Params. This parameter is not required for this API. |
Direction | Yes | Integer | 0: outbound rule; 1: inbound rule |
Area | Yes | String | Region code (e.g. ap-guangzhou ). All Tencent Cloud regions are supported. |
SearchValue | No | String | Search value |
Limit | No | Integer | Number of entries per page. Default: 10 |
Offset | No | Integer | Offset. Default: 0 |
Status | No | String | Status. Null: all; '0': filter disabled rules; '1': filter enabled rules |
Filter | No | Integer | 0: not filter; 1: filter out normal rules to retain abnormal rules |
Parameter Name | Type | Description |
---|---|---|
Total | Integer | Total rules in the list |
Data | Array of SecurityGroupListData | Security group rule list data |
AllTotal | Integer | Total entries excluding the filtered ones |
Enable | Integer | All access control rules enabled/disabled Note: This field may return null , indicating that no valid value was found. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityGroupList
<Common request parameters>
{
"SearchValue": "",
"Direction": 1,
"Limit": 20,
"Offset": 0,
"Filter": 0,
"Status": "",
"Area": "ap-guangzhou"
}
{
"Response": {
"Total": 0,
"AllTotal": 0,
"Enable": 1,
"Data": [
{
"Status": 1,
"TargetType": 1,
"VpcId": "vpc-khmhp1co1",
"Protocol": "ANY",
"SourceType": 1,
"IsNew": 1,
"SourceId": "ins-1kub1g5f",
"Port": "-1/-1",
"TargetId": "0.0.0.0/0",
"Detail": "Add rule (test)",
"PrivateIp": "172.27.0.17",
"PublicIp": "119.27.187.24",
"OrderIndex": 1,
"SubnetId": "subnet-9qs6catf",
"Cidr": "",
"Strategy": 1,
"InstanceName": "Chengdu agreements - Do not delete",
"Id": 1,
"BothWay": 1
}
],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
InvalidParameter | Invalid parameter. |
LimitExceeded | The quota limit has been reached. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?