Last updated: 2021-07-28 16:56:07

    1. API Description

    Domain name for API request:

    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.

    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:

    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: DescribeProjectSecurityGroups.
    Version Yes String Common parameter. The value used for this API: 2018-04-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: mariadb, cdb, cynosdb, dcdb, redis, mongodb.
    ProjectId Yes Integer Project ID.
    Offset No Integer Offset.
    Limit No Integer The number of security groups to be pulled.
    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 the security groups meeting the condition.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Sample request

    Input Example
    &<Common request parameters>

    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


    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
    FailedOperation.AddInstanceInfoFailed Failed to add the security group information of an instance.
    FailedOperation.AssociateSecurityGroupsFailed Failed to associate the security group.
    FailedOperation.ClearInstanceInfoFailed Failed to clear the security group information of an instance.
    FailedOperation.DisassociateSecurityGroupsFailed Failed to unassociate the security group.
    FailedOperation.DtsStatusAbnormal This operation is not allowed under the current DTS state.
    FailedOperation.FlowNotExists No process exists.