Check Unique Log Task Names with CheckUserProjectName API - 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:CheckUserProjectName

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the real-time log delivery task.	ali-dcdn-log-56

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	34DCBC8A-**--**-6DAA11D7DDBD
Check	boolean	Indicates whether the name is valid. Valid values: true false	true
ProjectName	string	The name of the real-time log delivery task.	ali-dcdn-log-56
Description	string	The reason why the name passed or failed the check.	project name pass the check

Examples

Success response

JSON format

{
  "RequestId": "34DCBC8A-****-****-****-6DAA11D7DDBD",
  "Check": true,
  "ProjectName": "ali-dcdn-log-56",
  "Description": "project name pass the check"
}

Error codes

HTTP status code	Error code	Error message	Description
400	RealtimeLogProjectExistError	Realtime-log project name already exist.	Real-time log entry name already exists
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalError	An internal exception occurred, please try again later.	An inner exception was triggered. Please try again later.
403	EsaService.NotOpen	ESA service has not opend.	Edge Security Accelerator (ESA) is not turned on

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.