UpdateInstanceIpWhiteList-阿里云帮助中心

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

lindorm:UpdateInstanceIpWhiteList

update

*instance

acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. Call the GetLindormInstanceList operation to obtain the ID.	ld-bp1z3506imz2f****
SecurityIpList	string	Yes	The IP addresses to add to the whitelist. Note Set this parameter to 127.0.0.1 to deny access from all IP addresses. For example, 192.168.0.0/24 allows all IP addresses in the 192.168.0.0/24 CIDR block to access the Lindorm instance. Separate multiple IP addresses or CIDR blocks with a comma (,).	192.168.0.X/24
GroupName	string	No	The name of the whitelist group. If you leave this parameter empty, the default value user is used.	test_group
Delete	boolean	No	Specifies whether to clear the whitelist.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4944539D-D27C-458D-95F1-2DCEB5E0EED5
AccessDeniedDetail	string	The detailed reason why the access is denied.	{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}

Examples

Success response

JSON format

{
  "RequestId": "4944539D-D27C-458D-95F1-2DCEB5E0EED5",
  "AccessDeniedDetail": "{\"AuthAction\":\"xxx\",\"AuthPrincipalDisplayName\":\"222\",\"AuthPrincipalOwnerId\":\"111\",\"AuthPrincipalType\":\"SubUser\",,\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\",\"EncodedDiagnosticMessage\":\"xxxxxx\"}"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Instance.IsDeleted	The instance is deleted.	The specified instance is already deleted.
400	Instance.IsNotValid	The instance is invalid.	The specified instance is invalid.
403	API.Forbidden	The API operation is forbidden in this environment.	This operation is not supported in the current environment.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.	You are not authorized to manage the specified resource.
403	Lindorm.Errorcode.ServiceLinkedRoleNoPermission	No permission to create service linked role.	You are not authorized to create the service-linked role.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.