Update Custom Lists with UpdateList API and RAM Auth - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

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

esa:UpdateList

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The ID of the custom list. You can obtain the ID by calling the ListLists operation.	40000001
Name	string	Yes	The new name of the custom list. If this parameter is not specified, the original name is retained. Naming rules: Only letters, digits, and underscores are supported (`^\w{1,64}$`). The name must be 1 to 64 characters in length.	example
Description	string	Yes	The new description of the list.	a custom list
Items	array	Yes	The new list content. The value is a JSON array string, for example, `["1.1.1.1","2.2.2.2"]`. Full overwrite semantics: The specified `Items` value completely overwrites the existing list content instead of appending to it. Note ⚠️ If this parameter is not specified or is set to an empty value, the existing list content is cleared. To retain existing items and append new ones, call `GetList` to retrieve the current `Items`, merge them, and then submit the combined list. Element format: The format depends on the `Kind` value specified when the list was created. UpdateList does not support modifying Kind. Kind = `ip`: Each element must be a valid IP address or CIDR block. If an element is invalid, `WrongValueMatched` is returned. Other Kind values: The element format is subject to the relevant specifications. The number of elements is limited by the tenant quota `NumberItemsPerList`. This limit does not apply to the `ip` Kind.	a custom list
	string	No	The updated list content item.	10.1.1.1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
403	%s.NotSupport	The specified resource type %s is not supported.	The specified resource type is not supported. To use this type of resource, please contact us.
403	%s.OverQuota	The quantity of %s exceeds the quota.	The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.
403	%s.WrongValueMatched	The value of specified parameter %s can not pass the matching check.	The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.
403	List.NotExist	The specified list does not exist.	The specified list does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.