GetRoutine API Response Structure & Routine Configuration Overview - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries all configuration information of an Edge Routine, including the code version list, environment configuration list, associated domain name configuration list, and associated route configuration list.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the Edge Routine.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.
Envs	array<object>	The list of environment context.
	array<object>	The environment context.
Env	string	The environment name.
CodeDeploy	object	The percentage-based canary release deployment information.
DeployId	string	O ID do registro de implantação.
CreationTime	string	A hora em que a implantação foi criada. A hora segue o padrão RFC 3339 no fuso horário UTC.
Strategy	string	A estratégia de implantação. Valor padrão: percentage. Valid values: percentage : percentage.
CodeVersions	array<object>	A lista de números de versões de código implantadas.
	object	As informações sobre uma única versão de código implantada.
CodeVersion	string	O número da versão do código.
Percentage	integer	A porcentagem de implantação de liberação canário da versão do código.
Description	string	A descrição da versão do código.
CreateTime	string	A hora em que a versão do código foi criada. A hora segue o padrão RFC 3339 no fuso horário UTC.
CreateTime	string	The time when the Edge Routine was created. The time follows the RFC 3339 standard in the UTC time zone.
Description	string	The description of the Edge Routine.
DefaultRelatedRecord	string	The default access record.
HasAssets	boolean	Indicates whether the Routine has the Assets tag.

Examples

Success response

JSON format

{
  "RequestId": "",
  "Envs": [
    {
      "Env": "",
      "CodeDeploy": {
        "DeployId": "",
        "CreationTime": "",
        "Strategy": "",
        "CodeVersions": [
          {
            "CodeVersion": "",
            "Percentage": 0,
            "Description": "",
            "CreateTime": ""
          }
        ]
      }
    }
  ],
  "CreateTime": "",
  "Description": "",
  "DefaultRelatedRecord": "",
  "HasAssets": false
}

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	InvalidParameter	Parameter verification failed. Check your configurations and try again.	Parameter verification failed. Check your configurations and try again.
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	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.