PrevNext
search by keyword

Recent Pages

Documentation
TencentDB for Redis
    Documentation
    Download PDF

    DescribeProjectSecurityGroup

    Last updated: 2021-11-18 10:45:14
    Download PDF

    1. API Description

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

    This API is used to query the security group information 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 parameter. The value used for this API: DescribeProjectSecurityGroup.
    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.
    ProjectId No Integer 0: default project; -1: all projects; >0: specified project
    SecurityGroupId No String Security group ID

    3. Output Parameters

    Parameter Name Type Description
    SecurityGroupDetails Array of SecurityGroupDetail Security group of a project
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the security group information of a project

    Input Example

    https://redis.tencentcloudapi.com/?Action=DescribeProjectSecurityGroup
&SecurityGroupId=sg-gl1egaj1
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "4cc888c8-cc1c-4a77-9259-dd0f6907b559",
    "SecurityGroupDetails": [
      {
        "CreateTime": "2018-01-30 15:58:00",
        "InboundRule": [
          {
            "Action": "ACCEPT",
            "Ip": "0.0.0.0/0",
            "Port": "ALL",
            "Proto": "ALL"
          },
          {
            "Action": "ACCEPT",
            "Ip": "0.0.0.0/0",
            "Port": "ALL",
            "Proto": "ALL"
          }
        ],
        "OutboundRule": [
          {
            "Action": "ACCEPT",
            "Ip": "0.0.0.0/0",
            "Port": "ALL",
            "Proto": "ALL"
          }
        ],
        "ProjectId": 0,
        "SecurityGroupId": "sg-gl1egaj1",
        "SecurityGroupName": "all",
        "SecurityGroupRemark": ""
      }
    ]
  }
}

    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
    InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
    InternalError.InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    ResourceUnavailable.GetSecurityError Failed to get the security group information.
    ResourceUnavailable.SecurityGroupNotSupported The product has not been connected to any security group.
    UnauthorizedOperation Unauthorized operation.
    UnauthorizedOperation.NoCAMAuthed No CAM permissions.
    UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy