CreateRoutineCodeDeployment - Deploy routine code version | ESA API - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Operation description

Usage notes

When creating a Routine code version deployment, the Env parameter only supports staging for the staging environment or production for the production environment.
The CodeVersions parameter supports a maximum of two versions for canary release, and the total percentage of these versions must equal 100%.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the Edge Function Routine.
Env	string	Yes	The environment name. Valid values: `staging`: staging environment `production`: production environment	production
Strategy	string	Yes	The deployment strategy. Valid values: `percentage`: percentage mode	percentage
CodeVersions	array<object>	Yes	The list of percentage-based canary release version configurations. A maximum of two versions are supported, and the total percentage must equal 100.
	object	Yes	A single percentage-based canary release version configuration.
Percentage	integer	Yes	The canary release percentage for the code version. Valid values: 1 to 100.
CodeVersion	string	Yes	The code version number.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.
Strategy	string	The canary release strategy. Fixed value: percentage.
DeploymentId	string	The deployment record ID.
CodeVersions	array<object>	The list of percentage-based canary release code version configurations.
	object	A single percentage-based canary release code version configuration.
Percentage	integer	The canary release percentage for the code version.
CodeVersion	string	The code version number.

Examples

Success response

JSON format

{
  "RequestId": "",
  "Strategy": "",
  "DeploymentId": "",
  "CodeVersions": [
    {
      "Percentage": 0,
      "CodeVersion": ""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.
400	RoutineNotExist	The routine name does not exist. Check the routine name and try again.	The routine name does not exist. Check the routine name and try again.
400	ParameterNotExist	The specified parameter does not exist. Check your configurations and try again.	The specified parameter does not exist. Check your configurations and try again.
400	InternalOperationError	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	DependedByOthers	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	RoutineUserServiceStatusHalt	Failed to update the configurations because you have overdue payments.	Failed to update the configurations because you have overdue payments.
400	InvalidParameter	Parameter verification failed. Check your configurations and try again.	Parameter verification failed. Check your configurations and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.