Manage Cross-Product IP Whitelists with ModifySecurityIPGroupRelation - DAS - Alibaba Cloud - Database Autonomy Service

Attaches or detaches a cross-engine whitelist template to or from a user.

Operation description

When using the Alibaba Cloud or DAS SDK, use the latest version.
When calling DAS by using the SDK, set the region to cn-shanghai.
For information about the supported database instances, see the feature overview of SQL Explorer.
SQL Explorer (original version) must be enabled for the target database instance. For more information, see Enable SQL Explorer and Audit.

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:ModifySecurityIPGroupRelation

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionName	string	Yes	The region ID.	cn-shanghai
InstanceId	string	Yes	The database instance ID.	pc-bp1u5mas9exx7****
GlobalSecurityGroupId	string	Yes	The ID of the IP whitelist template.	g-ggh7qvrrwikyxe****

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	string	The status code.	200
Data	object	ListResult
GlobalSecurityIPGroupRel	array<object>	The binding information of the cross-engine IP whitelist template.
	object
RegionId	string	The region ID.	cn-shanghai
GlobalIgName	string	The name of the IP whitelist template. The name must meet the following requirements: Contains only lowercase letters, digits, and underscores (_). Starts with a letter and ends with a letter or digit. Contains 2 to 120 characters in length.	saas_jump
GlobalSecurityGroupId	string	The ID of the IP whitelist template.	g-v8kwereyd6u7kx****
GIpList	string	The IP addresses in the whitelist template. Note Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks across all IP whitelists.	192.168.0.1,192.168.100.0/24
InstanceId	string	The instance ID.	rm-2ze1jdv45i7l6****
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	840F51F7-9C01-538D-94F6-AE712905****
Success	string	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": {
    "GlobalSecurityIPGroupRel": [
      {
        "RegionId": "cn-shanghai",
        "GlobalIgName": "saas_jump",
        "GlobalSecurityGroupId": "g-v8kwereyd6u7kx****",
        "GIpList": "192.168.0.1,192.168.100.0/24"
      }
    ],
    "InstanceId": "rm-2ze1jdv45i7l6****"
  },
  "Message": "Successful",
  "RequestId": "840F51F7-9C01-538D-94F6-AE712905****",
  "Success": "true"
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.