All Products
Search

This Product

    PolarDB:CreateGlobalSecurityIPGroup

    Document Center

    PolarDB:CreateGlobalSecurityIPGroup

    Last Updated:Jun 17, 2024

    Creates a global IP whitelist template.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-************
    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 address in the whitelist template.

    Note Multiple IP addresses are separated by commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP whitelists.
    		192.168.0.1

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		9B7BFB11-C077-4FE3-B051-F69CEB******
    GlobalSecurityIPGroupobject []

    The details of the global IP whitelist template.

    GlobalSecurityGroupIdstring

    The ID of the IP whitelist template.

    		g-zsldxfiwjmti0kcm****
    GlobalIgNamestring

    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 a digit.
    • The name must be 2 to 120 characters in length.
    		test_123
    GIpListstring

    The IP address in the whitelist template.

    Note Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.
    		192.168.0.1
    RegionIdstring

    The ID of the region.

    		cn-hangzhou

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-zsldxfiwjmti0kcm****",
      "GlobalIgName": "test_123",
      "GIpList": "192.168.0.1",
      "RegionId": "cn-hangzhou"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400RequiredParam.NotFoundRequired input param is not found.The specified parameter does not exist.
    400InvalidSecurityIPList.QuotaExceededSpecified security IP list is not valid: Exceeding the allowed amount of IP address in the list.The maximum number of security group IP addresses is reached.
    400InvalidSecurityIPList.FormatSpecified security IP list format is not valid.The format of the specified IP address in the whitelist is invalid.
    400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the listThe specified IP address whitelist is invalid, because the whitelist contains duplicate IP addresses.
    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
    2023-05-11The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404