All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeGlobalSecurityIPGroup

Last Updated:Oct 30, 2024

Queries global IP whitelist templates.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:DescribeGlobalSecurityIPGroupget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The resource group ID.

rg-acfmyiu4ekp****
RegionIdstringYes

The region ID.

cn-hangzhou
GlobalSecurityGroupIdstringNo

The ID of the IP whitelist template.

g-zsldxfiwjmti0kcm****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

2FF6158E-3394-4A90-B634-79C49184****
GlobalSecurityIPGrouparray<object>

The information about the IP whitelist template.

GlobalSecurityIPGroupobject

1

GlobalSecurityGroupIdstring

The ID of the IP whitelist template.

g-zsldxfiwjmti0kcm****
GlobalIgNamestring

The name of the IP whitelist template.

test_123
GIpListstring

The IP address in the IP whitelist template.

Note Multiple IP addresses are separated by commas (,).
125.38.177.62,221.197.232.185
RegionIdstring

The region ID.

cn-hangzhou
DBInstancesarray

The IDs of the instances that are associated with the IP whitelist template.

DBInstancesstring

The instance ID.

r-****

Examples

Sample success responses

JSONformat

{
  "RequestId": "2FF6158E-3394-4A90-B634-79C49184****",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-zsldxfiwjmti0kcm****",
      "GlobalIgName": "test_123",
      "GIpList": "125.38.177.62,221.197.232.185",
      "RegionId": "cn-hangzhou",
      "DBInstances": [
        "r-****"
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400RequiredParam.NotFoundRequired input param is not found.Missing input parameter
400InvalidActionSpecified action is not valid.The specified operation is invalid.
404InvalidUser.NotFoundSpecified user does not exist.The specified account does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history