Domain name for API request: dcdb.tencentcloudapi.com.
This API is used to query the security group information of an instance.
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: DescribeDBSecurityGroups. |
Version | Yes | String | Common Params. The value used for this API: 2018-04-11. |
Region | No | String | Common Params. This parameter is not required for this API. |
Product | Yes | String | Database engine name. Valid value: dcdb . |
InstanceId | Yes | String | Instance ID |
Parameter Name | Type | Description |
---|---|---|
Groups | Array of SecurityGroup | Security group details |
VIP | String | Instance VIP Note: This field may return null, indicating that no valid values can be obtained. |
VPort | String | Instance Port Note: This field may return null, indicating that no valid value can be obtained. |
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: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBSecurityGroups
<Common request parameters>
{
"InstanceId": "tdsqlshard-eb2w7dto",
"Product": "dcdb"
}
{
"Response": {
"VIP": "10.0.0.7",
"VPort": 3306,
"RequestId": "31a60135-7057-47ae-8fd3-7a0617deca38",
"Groups": [
{
"ProjectId": 0,
"CreateTime": "",
"Inbound": [
{
"Action": "",
"CidrIp": "",
"PortRange": "",
"IpProtocol": ""
}
],
"Outbound": [
{
"Action": "",
"CidrIp": "",
"PortRange": "",
"IpProtocol": ""
}
],
"SecurityGroupId": "",
"SecurityGroupName": "",
"SecurityGroupRemark": "dcdb"
}
]
}
}
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 |
FailedOperation.AuthNoStrategy | Authentication failed. |
FailedOperation.GetSecurityGroupDetailFailed | Failed to query the security group details |
InternalError.GetSecurityGroupDetailFailed | Failed to query security group details. |
InternalError.InstanceOperatePermissionError | You have no permission to operate this instance. |
InternalError.ListInstanceRespResourceCountNotMatchError | The number of resources returned is inconsistent with the number specified in the request of querying instance information. |
InternalError.ListInstancesError | An error occurred when querying instance information. |
InternalError.QueryDatabaseFailed | An error occurred when reading data from the database. |
InternalError.ReadDatabaseFailed | An error occurred when reading data from the database. |
InternalError.RouteNotFound | Route not found. |
InvalidParameter | Parameter error. |
InvalidParameter.IllegalParameterError | Invalid parameters. |
InvalidParameter.InstanceNotFound | Failed to find the requested instance. |
InvalidParameter.PermissionDenied | You have no permission to manipulate this API or resource. |
InvalidParameterValue.InvalidParameterValueError | Parameter input error |
ResourceNotFound.InstanceNotFound | The instance doesn’t exist. |
ResourceNotFound.ProductConfigNotExistedError | Failed to find the configuration of the product associated with the security group. |
ResourceUnavailable.InstanceStatusAbnormal | Incorrect database instance status. Operations are not allowed. |
UnauthorizedOperation.PermissionDenied | You have no permission to manipulate this API or resource. |
Was this page helpful?