Manage Multi-Product IP Whitelists with CreateSecurityIPGroup API - Database Autonomy Service

Creates a whitelist template that can be used across multiple products.

Operation description

The maximum number of concurrent executions is 10.

Use the latest version of the Alibaba Cloud or DAS SDK.
When you call the DAS service using an SDK, set the region to cn-shanghai.
Only database instances for which DAS Enterprise Edition is enabled support the creation of offline tasks. For more information about the databases and regions supported by each version of DAS Enterprise Edition, see DAS editions and supported features.

API limits:

The maximum number of concurrent executions is 10.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:CreateSecurityIPGroup

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionName	string	Yes	The region ID.	cn-beijing
GlobalIgName	string	Yes	The name of the IP address whitelist template. The name must meet the following requirements: Consists of lowercase letters, digits, and underscores (_). Starts with a letter and ends with a letter or a digit. Is 2 to 120 characters in length.	test_123
GIpList	string	Yes	The IP addresses in the whitelist template. Note Separate multiple IP addresses with commas (,). The IP addresses cannot be repeated. You can add up to 1,000 IP addresses.	192.168.0.1

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Data	object	The list of results.
GlobalSecurityIPGroup	array<object>	The information about the cross-product whitelist template.
	object
SecurityIpType	string	The IP address type.	ipv4
RegionId	string	The region ID. Example: cn-hangzhou	cn-shenzhen
GlobalIgName	string	The name of the IP address whitelist template. The name must meet the following requirements: Consists of lowercase letters, digits, and underscores (_). Starts with a letter and ends with a letter or a digit. Is 2 to 120 characters in length.	test
GlobalSecurityGroupId	string	The ID of the IP address whitelist template.	g-2uztsd6yvhmsqyjXXX
WhitelistNetType	string	The network type of the whitelist.	mix
GIpList	string	The IP addresses in the whitelist template. Note Separate multiple IP addresses with commas (,). A cumulative total of 1,000 IP addresses or CIDR blocks can be added to all IP address whitelists.	192.168.0.0/24
Message	string	The message returned for the request. Note If the request is successful, Successful is returned. If the request fails, an error message is returned, such as an error code.	Successful
RequestId	string	The request ID.	D578DB3C-06BF-54F2-A78F-C6C25Exxxxxx
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": {
    "GlobalSecurityIPGroup": [
      {
        "SecurityIpType": "ipv4",
        "RegionId": "cn-shenzhen",
        "GlobalIgName": "test",
        "GlobalSecurityGroupId": "g-2uztsd6yvhmsqyjXXX",
        "WhitelistNetType": "mix",
        "GIpList": "192.168.0.0/24"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "D578DB3C-06BF-54F2-A78F-C6C25Exxxxxx",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.