Get Edge Container App Version Info via API - Edge Security Acceleration

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

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID, which can be obtained by calling the ListEdgeContainerApps operation.	app-88068867578379****
VersionId	string	Yes	The version ID, which can be obtained by calling the ListEdgeContainerAppVersions operation.	ver-87962637161651****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Version	object	The information about the version.
LastPublishTime	string	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
PublishTime	string	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
Status	string	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
CreateTime	string	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
AppId	string	The application ID.	app-88068867578379****
VersionId	string	The ID of the created version.	ver-87962637161651****
Name	string	The version name.	test
UpdateTime	string	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
Remarks	string	The remarks.	aaa
Containers	array<object>	The container images deployed for this version.
	array<object>	The details of the container image deployed for this version.
EnvVariables	string	The environment variables.	ENV=prod
Args	string	The arguments that are passed to the container startup command.	-c /path/config.toml
Spec	string	The compute specification.	1C2G
Storage	string	The storage capacity of the container. Valid values: 0.5G, 10G, 20G, and 30G.	0.5G
IsACRImage	boolean	Indicates whether the image is a Container Registry image.	false
ACRImageInfo	object	The information about the Container Registry image.
Domain	string	The domain name of the Container Registry image.	*.mooc.seewo.com
InstanceId	string	The ID of the Container Registry instance.	xcdn-9ak2thl14z5s
RegionId	string	The region ID.	cn-hangzhou
RepoId	string	The ID of the image repository.	crr-zeu0xyk28alyxozh
RepoName	string	The name of the image repository.	test_1
RepoNamespace	string	The namespace to which the image repository belongs.	wpy1
Tag	string	The tag value.	test-healthy-100-soa-1710987653
TagUrl	string	The URL of the Container Registry image tag.	registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2
IsEnterpriseRegistry	boolean	Indicates whether the image is an enterprise-level image.	false
Image	string	The image address.	nginx:1.14.0
Command	string	The command that is used to start the container.	sh abc.sh 1 2 3
ProbeType	string	The probe type.	httpGet
Name	string	The version name.	version01
PreStop	string	The command that is run before the container is stopped.	sh prestop.sh "echo hello world"
PostStart	string	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.	sh poststart.sh "echo hello world"
ProbeContent	object	The probe content.
SuccessThreshold	integer	The number of consecutive successful health checks required for a container to be considered as healthy.	1
Host	string	The domain name that is used for health checks.	test.com
HttpHeaders	string	The request headers that are included in the container health check request.	[{\"Content-Type\":\"application/json
Scheme	string	The protocol that the container health check request uses.	http
InitialDelaySeconds	integer	The latency for container probe initialization.	20
Command	string	The probe command.	sh test.sh
FailureThreshold	integer	The number of consecutive failed health checks required for a container to be considered as unhealthy.	3
TimeoutSeconds	integer	The timeout period of the container health check.	5
Path	string	The path of the container health check.	/health_check
Port	integer	The port of the container health check. Valid values: 1 to 65535.	80
PeriodSeconds	integer	The interval between container health checks.	5

Examples

Success response

JSON format

{
  "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": "0.5G",
        "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": "sh poststart.sh \"echo hello world\" ",
        "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 code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InvalidParameter.appid	The 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.
400	InvalidVersion.NotFound	The version does not exist.	This version number does not exist.
400	InvalidParameter.VersionId	The 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.
500	InternalError	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
404	InvalidApp.NotFound	The 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.