TencentDB for Redis®
- Release Notes and Announcements
- Product Introduction
- Product Series
- Purchase Guide
- Getting Started
- Operation Guide
- Access Management
- SDK Connection
- Daily Instance Operation
- Upgrading Redis Edition Instances
- Managing Redis Edition Nodes
- Multi-AZ Deployment Management
- Backup and Restoration
- Downloading Redis Edition Backups
- Data Migration for Redis Edition Instances
- Account and Password (Redis Edition)
- Parameter Configuration
- Redis Parameter Operations
- Network and Security
- Monitoring and Alarms
- Redis Edition Event Management
- Global Replication for Redis Edition
- Performance Optimization
- Development Guidelines
- Connection Pool Configuration
- Command Reference
- Commands Supported by Different Versions
- Additional Command Operations in the Redis Edition
- Troubleshooting
- Connection Exception
- Performance Troubleshooting and Fine-Tuning
- Practical Tutorial
- API Documentation
- Making API Requests
- Instance APIs
- Parameter Management APIs
- Other APIs
- Backup and Restoration APIs
- Monitoring and Management APIs
- Service Agreement
DescribeProjectSecurityGroups
Last updated: 2024-12-04 11:18:53
1. API Description
Domain name for API request: redis.intl.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.
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: DescribeProjectSecurityGroups. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Product | Yes | String | Database engine name, which is redis for this API. |
| ProjectId | No | Integer | Project ID. Log in to the Project Management page of the Redis console and copy the project ID in Project Name. |
| 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. |
3. Output Parameters
| 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. |
4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectSecurityGroups
<Common request parameters>
{
"ProjectId": "11954",
"Product": "redis"
}
Output Example
{
"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"
}
]
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| 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. |
| FailedOperation.GetSecurityGroupDetailFailed | Failed to query the security group details. Try again later. |
| InvalidParameter.ActionNotFound | The corresponding API was not found. |
| InvalidParameter.IllegalParameterError | Invalid parameter. |
| InvalidParameter.NotSupported | The operation is unsupported due to incorrect parameters. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No