All Products
Search
Document Center

Edge Security Acceleration:GetEdgeContainerAppVersion

Last Updated:Mar 27, 2025

Queries the information about a version of a containerized application. You can select an application version to release based on the version information.

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:GetEdgeContainerAppVersionget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The application ID, which can be obtained by calling the ListEdgeContainerApps operation.

app-88068867578379****
VersionIdstringYes

The version ID, which can be obtained by calling the ListEdgeContainerAppVersions operation.

ver-87962637161651****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
Versionobject

The information about the version.

LastPublishTimestring

The time when the version was last released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2023-07-25T04:58:05Z
PublishTimestring

The time when the version was released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2022-11-14T02:04:03Z
Statusstring

The status of the current version. Valid values:

  • created: The version is created.
  • failed: The version failed to be created.
  • creating: The version is being created.
created
CreateTimestring

The time when the version was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2022-07-01T09:32:33Z
AppIdstring

The application ID.

app-88068867578379****
VersionIdstring

The ID of the created version.

ver-87962637161651****
Namestring

The version name.

test
UpdateTimestring

The time when the version was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2021-12-03T10:52:52Z
Remarksstring

The remarks.

aaa
Containersarray<object>

The container images deployed for this version.

ContainerItemobject

The details of the container image deployed for this version.

EnvVariablesstring

The environment variables.

ENV=prod
Argsstring

The arguments that are passed to the container startup command.

-c /path/config.toml
Specstring

The compute specification.

1C2G
Storagestring

The storage capacity of the container. Valid values: 0.5G, 10G, 20G, and 30G.

IsACRImageboolean

Indicates whether the image is a Container Registry image.

false
ACRImageInfoobject

The information about the Container Registry image.

Domainstring

The domain name of the Container Registry image.

*.mooc.seewo.com
InstanceIdstring

The ID of the Container Registry instance.

xcdn-9ak2thl14z5s
RegionIdstring

The region ID.

cn-hangzhou
RepoIdstring

The ID of the image repository.

crr-zeu0xyk28alyxozh
RepoNamestring

The name of the image repository.

test_1
RepoNamespacestring

The namespace to which the image repository belongs.

wpy1
Tagstring

The tag value.

test-healthy-100-soa-1710987653
TagUrlstring

The URL of the Container Registry image tag.

registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2
IsEnterpriseRegistryboolean

Indicates whether the image is an enterprise-level image.

false
Imagestring

The image address.

nginx:1.14.0
Commandstring

The command that is used to start the container.

sh abc.sh 1 2 3
ProbeTypestring

The probe type.

httpGet
Namestring

The version name.

version01
PreStopstring

The command that is run before the container is stopped.

sh prestop.sh "echo hello world"
PostStartstring

The command that is run before the container is started. Format: {"exec":{"command":\["cat","/etc/group"\]}}. If you want to cancel this configuration, set the parameter value to "" or {}. If you do not specify this parameter, this configuration is ignored.

{\"exec\":{\"command\":[\"touch\",\"/home/admin/checkpoststartV1\"]}}
ProbeContentobject

The probe content.

SuccessThresholdinteger

The number of consecutive successful health checks required for a container to be considered as healthy.

1
Hoststring

The domain name that is used for health checks.

test.com
HttpHeadersstring

The request headers that are included in the container health check request.

[{\"Content-Type\":\"application/json
Schemestring

The protocol that the container health check request uses.

http
InitialDelaySecondsinteger

The latency for container probe initialization.

20
Commandstring

The probe command.

sh test.sh
FailureThresholdinteger

The number of consecutive failed health checks required for a container to be considered as unhealthy.

3
TimeoutSecondsinteger

The timeout period of the container health check.

5
Pathstring

The path of the container health check.

/health_check
Portinteger

The port of the container health check. Valid values: 1 to 65535.

80
PeriodSecondsinteger

The interval between container health checks.

5

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Version": {
    "LastPublishTime": "2023-07-25T04:58:05Z",
    "PublishTime": "2022-11-14T02:04:03Z",
    "Status": "created",
    "CreateTime": "2022-07-01T09:32:33Z",
    "AppId": "app-88068867578379****",
    "VersionId": "ver-87962637161651****",
    "Name": "test",
    "UpdateTime": "2021-12-03T10:52:52Z",
    "Remarks": "aaa",
    "Containers": [
      {
        "EnvVariables": "ENV=prod",
        "Args": "-c /path/config.toml",
        "Spec": "1C2G",
        "Storage": "",
        "IsACRImage": false,
        "ACRImageInfo": {
          "Domain": "*.mooc.seewo.com",
          "InstanceId": "xcdn-9ak2thl14z5s",
          "RegionId": "cn-hangzhou",
          "RepoId": "crr-zeu0xyk28alyxozh",
          "RepoName": "test_1",
          "RepoNamespace": "wpy1",
          "Tag": "test-healthy-100-soa-1710987653",
          "TagUrl": "registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2",
          "IsEnterpriseRegistry": false
        },
        "Image": "nginx:1.14.0",
        "Command": "sh abc.sh 1 2 3",
        "ProbeType": "httpGet",
        "Name": "version01",
        "PreStop": "sh prestop.sh \"echo hello world\" ",
        "PostStart": "{\\\"exec\\\":{\\\"command\\\":[\\\"touch\\\",\\\"/home/admin/checkpoststartV1\\\"]}}",
        "ProbeContent": {
          "SuccessThreshold": 1,
          "Host": "test.com",
          "HttpHeaders": "[{\\\"Content-Type\\\":\\\"application/json",
          "Scheme": "http",
          "InitialDelaySeconds": 20,
          "Command": "sh test.sh",
          "FailureThreshold": 3,
          "TimeoutSeconds": 5,
          "Path": "/health_check",
          "Port": 80,
          "PeriodSeconds": 5
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.The specified parameter is invalid.
400InvalidParameter.appidThe format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.
400InvalidVersion.NotFoundThe version does not exist.This version number does not exist.
400InvalidParameter.VersionIdThe specified VersionId is invalid.  Please check the VersionId parameter. You may not have entered the parameter or the parameter does not start with ver-string. Please modify it and call the interface again.The VersionId parameter is invalid. Please check the VersionId parameter. You may not have entered the parameter or the parameter does not start with ver-string. Please modify it and call the interface again.
404InvalidApp.NotFoundThe application does not exist. Check whether the application ID you specified is correct and try again.The application does not exist. Check whether the application ID you specified is correct and try again.
500InternalErrorFailed 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-11-12The Error code has changed. The response structure of the API has changedView Change Details