Configure LindormV2 IP Whitelist for Secure Access via API - Lindorm - Alibaba Cloud - Lindorm

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

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the instance is located. You can call the DescribeRegions operation to obtain this ID.	cn-hangzhou
InstanceId	string	Yes	The ID of the instance. You can call the GetLindormV2InstanceList operation to obtain the instance ID.	ld-2ze5ipz9zx1e4****
WhiteIpGroupList	array<object>	Yes	The list of IP whitelist groups.
	object	No	A single IP whitelist group.
GroupName	string	Yes	The name of the IP whitelist group.	user001
WhiteIpList	string	Yes	The IP addresses to add to the IP whitelist. Note The value 127.0.0.1 denies access from all IP addresses. For example, 192.168.0.0/24 allows all IP addresses in that range to access the Lindorm instance. Use a comma (,) to separate multiple IP addresses or CIDR blocks.	192.168.0.X/24

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	0A7153E4-8354-497E-87E5-5D0EBEF5AEB1
AccessDeniedDetail	string	Details about a failed permission check.	{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}

Examples

Success response

JSON format

{
  "RequestId": "0A7153E4-8354-497E-87E5-5D0EBEF5AEB1",
  "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.
400	LindormErrorCode.%s	%s.	%s.
400	WhiteIpInUpdating	Instance is updating whiteIp now, please wait.	Please wait while the instance whitelist is updated.
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.