Domain name for API request: cdb.intl.tencentcloudapi.com.
This API (DescribeDBSecurityGroups) is used to query the security group details of an instance.
A maximum of 100 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: DescribeDBSecurityGroups. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. |
ForReadonlyInstance | No | Boolean | This parameter takes effect only when the ID of a read-only instance is passed in. If the parameter is set to False or left empty, the security groups bound with the RO groups of the read-only instance can only be queried. If it is set to True , the security groups can be modified. |
Parameter Name | Type | Description |
---|---|---|
Groups | Array of SecurityGroup | Security group details. |
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: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBSecurityGroups
<Common request parameters>
{
"InstanceId": "cdb-eb2w7dto"
}
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"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 |
---|---|
AuthFailure | CAM signature/authentication error. |
CdbError | Backend or process error. |
InternalError.CdbError | System error. |
InternalError.DBOperationError | Database operation failed. |
InternalError.DatabaseAccessError | Internal database error. |
InternalError.DfwError | Security group operation error. |
InternalError.InternalHttpServerError | An exception occurred while executing the request. |
InternalError.InternalServiceErrorErr | An error occurred while accessing internal service. |
InternalError.ResourceNotUnique | The resource is not unique. |
InternalError.SecurityGroupError | Security group error |
InternalError.UndefinedError | Unknown error |
InternalError.UnknownError | Unknown error |
InvalidParameter | Parameter error. |
InvalidParameter.ControllerNotFoundError | This API was not found. |
OperationDenied | Operation denied. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?