All Products
Search
Document Center

Edge Security Acceleration:GetRoutine

Last Updated:Nov 15, 2025

Queries the configurations of a routine, including the code versions and the configurations of the environments, associated domain names, and associated routes.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
esa:GetRoutinenone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringNo

The routine name.

GetRoutine

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
CodeVersionsarray<object>

The code versions.

CodeVersionItemobject

The information about the code version.

CodeDescriptionstring

The description of the code version.

test ver code desc
CreateTimestring

The time when the code version was created.

2024-03-11T01:23:21Z
CodeVersionstring

The code version.

1710120201067203242
RelatedRecordsarray<object>

The records associated with the routine.

RelatedRecordItemobject

The information about the record associated with the routine.

RecordNamestring

The record name.

test-record-1.example.com
SiteIdlong

The website ID.

54362329990032
SiteNamestring

The website name.

example.com
RecordIdlong

The record ID.

509348423011904
RelatedRoutesarray<object>

The routes associated with the routine.

RelatedRouteItemobject

The information about the route associated with the routine.

Routestring

The route.

*.example.com/path1*
SiteIdlong

The website ID.

54362329990032
SiteNamestring

The website name.

example.com
RouteIdstring

The route ID.

d501cb8a2c951f32922d260040780c06
Envsarray<object>

The information about the environments.

EnvItemobject

The information about the environment.

CanaryCodeVersionstring

The version number for canary release.

1710120201067577628
SpecNamestring

The specification.

5ms
Envstring

The environment type.

production
CodeVersionstring

The version number of the code in the environment.

1710120201067577628
CanaryAreaListarray

The regions for canary release.

CanaryAreaItemstring

The region for canary release.

Beijing
CreateTimestring

The time when the routine was created.

2024-03-11T01:23:21Z
Descriptionstring

The description of the routine.

ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg
DefaultRelatedRecordstring

The default record name to access.

routine1.example.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395",
  "CodeVersions": [
    {
      "CodeDescription": "test ver code desc",
      "CreateTime": "2024-03-11T01:23:21Z",
      "CodeVersion": 1710120201067203300
    }
  ],
  "RelatedRecords": [
    {
      "RecordName": "test-record-1.example.com",
      "SiteId": 54362329990032,
      "SiteName": "example.com",
      "RecordId": 509348423011904
    }
  ],
  "RelatedRoutes": [
    {
      "Route": "*.example.com/path1*",
      "SiteId": 54362329990032,
      "SiteName": "example.com\n",
      "RouteId": "d501cb8a2c951f32922d260040780c06"
    }
  ],
  "Envs": [
    {
      "CanaryCodeVersion": 1710120201067577600,
      "SpecName": "5ms",
      "Env": "production",
      "CodeVersion": 1710120201067577600,
      "CanaryAreaList": [
        "Beijing"
      ]
    }
  ],
  "CreateTime": "2024-03-11T01:23:21Z\n",
  "Description": "ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg",
  "DefaultRelatedRecord": "routine1.example.com"
}

Error codes

HTTP status codeError codeError messageDescription
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.
400InvalidParameterParameter verification failed. Check your configurations and try again.Parameter verification failed. Check your configurations and try again.
400RoutineNotExistThe 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.
400InternalOperationErrorFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-12-04The Error code has changed. The response structure of the API has changedView Change Details