All Products
Search
Document Center

Tair (Redis® OSS-Compatible):CreateGlobalSecurityIPGroup

Last Updated:Oct 30, 2024

Creates a global IP whitelist template.

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:CreateGlobalSecurityIPGroup
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The resource group ID.

rg-acfmyiu4ekp****
RegionIdstringYes

The region ID.

cn-hangzhou
GlobalIgNamestringYes

The name of the IP whitelist template. The name must meet the following requirements:

  • The name can contain lowercase letters, digits, and underscores (_).
  • The name must start with a letter and end with a letter or digit.
  • The name must be 2 to 120 characters in length.
test_123
GIpListstringYes

The IP addresses in the IP whitelist template.

Note Separate multiple IP addresses with commas (,). The maximum number of IP addresses is 1,000.
111.175.56.206,47.253.88.168,111.181.0.162

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

5D622714-AEDD-4609-9167-F5DDD3D1****
GlobalSecurityIPGrouparray<object>

The information about the global IP whitelist template.

GlobalSecurityIPGroupobject

1

GlobalSecurityGroupIdstring

The ID of the IP whitelist template.

g-sdgwqyp4f5j1x3qk7yvm
GlobalIgNamestring

The name of the IP whitelist template.

white_list_test_sg
GIpListstring

The IP addresses in the IP whitelist template.

192.168.0.1
RegionIdstring

The region ID.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-sdgwqyp4f5j1x3qk7yvm",
      "GlobalIgName": "white_list_test_sg",
      "GIpList": "192.168.0.1",
      "RegionId": "cn-hangzhou"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400RequiredParam.NotFoundRequired input param is not found.Missing input parameter
400InvalidSecurityIPList.QuotaExceededSpecified security IP list is not valid: Exceeding the allowed amount of IP address in the list.The number of IP addresses in the list exceeds the limit
400InvalidSecurityIPList.FormatSpecified security IP list format is not valid.The specified secure IP addresses are invalid.
400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the list-
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