All Products
Search

This Product

    ApsaraDB for MongoDB:CreateGlobalSecurityIPGroup

    Document Center

    ApsaraDB for MongoDB:CreateGlobalSecurityIPGroup

    Last Updated:Sep 03, 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
    dds:CreateGlobalSecurityIPGroupcreate
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    GlobalIgNamestringYes

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

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

    The IP addresses in the whitelist template.

    Note Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP address whitelists.
    		27.18.86.18,183.92.40.129

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		F8CA8312-530A-413A-9129-F2BB32A8D404
    GlobalSecurityIPGrouparray<object>

    The IP whitelist templates.

    object

    The IP whitelist template.

    GlobalSecurityGroupIdstring

    The ID of the IP whitelist template.

    		g-2ifynl1jfkdlhhxgva3q
    GlobalIgNamestring

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

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

    The IP addresses in the whitelist template.

    Note Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP address whitelists.
    		111.207.194.217,61.149.7.154
    RegionIdstring

    The region ID of the instance.

    		cn-hangzhou

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "F8CA8312-530A-413A-9129-F2BB32A8D404",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-2ifynl1jfkdlhhxgva3q",
      "GlobalIgName": "developer",
      "GIpList": "111.207.194.217,61.149.7.154",
      "RegionId": "cn-hangzhou"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400RequiredParam.NotFoundRequired input param is not found.-
    400InvalidSecurityIPList.QuotaExceededSpecified security IP list is not valid: Exceeding the allowed amount of IP address in the list.-
    400InvalidSecurityIPList.FormatSpecified security IP list format is not valid.The specified SecurityIPList parameter is invalid. Specify a valid whitelist. A whitelist can contain up to 1,000 different IP addresses. Separate multiple IP addresses with commas (,). Supported formats include 0.0.0.0/0, 10.23.12.24 (IP address), and 10.23.12.24/24 (CIDR block). /24 indicates the prefix of the CIDR block is 24-bit. You can replace 24 with a value ranging from 1 to 32.
    400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the list-
    404InvalidUser.NotFoundSpecified user does not exist.-

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

    Change history

    Change timeSummary of changesOperation
    No change history