DescribeDBSecurityGroups

Last updated: 2021-05-20 15:48:51

1. API Description

Domain name for API request: mariadb.tencentcloudapi.com.

This API is used to query the security group details of an instance.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mariadb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeDBSecurityGroups.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Product Yes String Database engine name. Valid value: mariadb.
InstanceId Yes String Instance ID

3. Output Parameters

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 Integer Instance port
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample 1. Querying the security group details of an instance

Input Example

https://mariadb.tencentcloudapi.com/?Action=DescribeDBSecurityGroups
&Product=mariadb
&InstanceId=tdsql-eb2w7dto
&<Common request parameters>

Output Example

{
  "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": "mariadb"
      }
    ]
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
AuthFailure CAM signature/authentication error
FailedOperation.AuthNoStrategy Authentication failed.
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 an instance.
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.
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.