Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the security group details of a project.
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: DescribeProjectSecurityGroups. |
Version | Yes | String | Common Params. The value used for this API: 2018-04-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
Product | Yes | String | Database engine name, which is redis for this API. |
ProjectId | Yes | Integer | Project ID |
Offset | No | Integer | Offset, which is an integral multiple of Limit . |
Limit | No | Integer | The number of security groups to be pulled. Default value: 20 . |
SearchKey | No | String | Search criteria. You can enter a security group ID or name. |
Parameter Name | Type | Description |
---|---|---|
Groups | Array of SecurityGroup | Security group rules. |
Total | Integer | Total number of eligible security groups. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectSecurityGroups
<Common request parameters>
{
"ProjectId": "11954",
"Product": "redis"
}
{
"Response": {
"Total": 1,
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A1",
"Groups": [
{
"Outbound": [],
"SecurityGroupName": "CDB",
"Inbound": [],
"ProjectId": 0,
"SecurityGroupId": "sg-ajr1jzgj",
"SecurityGroupRemark": "",
"CreateTime": "2017-04-13 15:00:06"
}
]
}
}
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.AddInstanceInfoFailed | Failed to add the security group information of the instance. |
FailedOperation.AssociateSecurityGroupsFailed | Failed to associate the security group. |
FailedOperation.ClearInstanceInfoFailed | Failed to clear the security group information of the instance. |
FailedOperation.DisassociateSecurityGroupsFailed | Failed to unbind the security group. |
FailedOperation.DtsStatusAbnormal | This operation is not allowed under the current DTS status. |
FailedOperation.FlowNotExists | No process exists. |
InvalidParameter.ActionNotFound | The corresponding API was not found. |
InvalidParameter.IllegalParameterError | Invalid parameter. |
InvalidParameter.PermissionDenied | The API has no CAM permissions. |
Was this page helpful?