All Products
Search
Document Center

Enterprise Distributed Application Service:GetApplication

Last Updated:Jan 08, 2024

Queries the details about a specified application in an Elastic Compute Service (ECS) cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:
    • The required resource types are displayed in bold characters.
    • 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
edas:ReadApplicationRead
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

POST /pop/v5/app/app_info

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

29f0******************

Response parameters

ParameterTypeDescriptionExample
object

The content that is returned.

Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

F8DFGED-K98***************
Applicationobject

The details of the application.

ExtSlbIpstring

The IP address of the Internet-facing Server Load Balancer (SLB) instance that is bound to the application.

47.114.xxx.xx
Ownerstring

The ID of the user who created the application.

ouou@117274586608****
SlbPortinteger

The port of the internal-facing SLB instance that is bound to the application.

80
NameSpacestring

The namespace to which the application belongs.

doc-test
ExtSlbNamestring

The name of the Internet-facing SLB instance that is bound to the application.

aa8eee383db084f42aebc4d9f52c****
CreateTimelong

The time when the application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1610550324226
UserIdstring

The ID of the Alibaba Cloud account.

test@dd******
Portinteger

The service port of the application.

8080
RunningInstanceCountinteger

The number of running instances for the application.

1
SlbIpstring

The IP address of the internal-facing SLB instance that is bound to the application.

192.168.0.100
Dockerizeboolean

Indicates whether the application is a Docker application. Valid values:

  • false: The application is not a Docker application.
  • true: The application is a Docker application.
false
Descriptionstring

The description of the application.

test
InstanceCountinteger

The number of instances deployed with the application.

1
AppIdstring

The ID of the application.

cfac****-847e-4325-ad56-b5c2bc54****
SlbInfostring

The information about the internal-facing SLB instance that is bound to the application.

test
Memoryinteger

The memory size of the application instance. Unit: MB.

0
Namestring

The name of the application.

test
ClusterIdstring

The ID of the ECS cluster in which the application is deployed.

5ffc5895-****-b03a-c223c6c3****
SlbIdstring

The ID of the internal-facing SLB instance that is bound to the application.

lb-bp****ck3s3b9xs6x****
HealthCheckUrlstring

The health check URL of the application.

http://127.0.0.1:8080/xyz.html
ApplicationTypestring

The deployment type of the application. Valid values:

  • War: The application is deployed by using a WAR package.
  • FatJar: The application is deployed by using a JAR package.
  • Empty: The application is not deployed.
FatJar
ExtSlbIdstring

The ID of the Internet-facing SLB instance that is bound to the application.

lb-bp1vceck3s3b9xs6x****
RegionIdstring

The ID of the region in which the application is deployed.

cn-hangzhou
BuildPackageIdlong

The build package number of Enterprise Distributed Application Service (EDAS) Container.

59
Emailstring

The email address of the account.

xxxx@gmail.com
Cpuinteger

The number of CPU cores.

1
ClusterTypestring

The type of the cluster. Valid values:

  • 0: regular Docker cluster
  • 1: Swarm cluster
  • 2: ECS cluster
  • 3: Kubernetes cluster
  • 4: cluster in which Pandora automatically registers applications
2
SlbNamestring

The name of the internal-facing SLB instance that is bound to the application.

test
EnableUrlCheckboolean

Indicates whether the URL health check is enabled. Valid values:

  • true: The URL health check is enabled.
  • false: The URL health check is disabled.

If the URL health check is enabled, EDAS attempts to detect the specified URL during application startup. If EDAS detects the specified URL, the application is considered to have started.

false
EnablePortCheckboolean

Indicates whether the port health check is enabled. Valid values:

  • true: The port health check is enabled.
  • false: The port health check is disabled.

If the port health check is enabled, EDAS checks whether a port exists during application startup. If the port exists, the application is considered to have started.

false
AppPhasestring

The current status of the Kubernetes application, which is used to determine whether the application is in a stable state. If the application is in an unstable state, related configuration operations are prohibited. Valid values:

  • ready: The application is in the ready state and can be changed.
  • progressive: The application is being changed.
  • pending: The application change is blocked.
  • failed: The application fails to be changed.

In these states, ready is a stable state and other states are unstable.

ready

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "F8DFGED-K98***************",
  "Application": {
    "ExtSlbIp": "47.114.xxx.xx",
    "Owner": "ouou@117274586608****",
    "SlbPort": 80,
    "NameSpace": "doc-test",
    "ExtSlbName": "aa8eee383db084f42aebc4d9f52c****",
    "CreateTime": 1610550324226,
    "UserId": "test@dd******",
    "Port": 8080,
    "RunningInstanceCount": 1,
    "SlbIp": "192.168.0.100",
    "Dockerize": false,
    "Description": "test",
    "InstanceCount": 1,
    "AppId": "cfac****-847e-4325-ad56-b5c2bc54****",
    "SlbInfo": "test",
    "Memory": 0,
    "Name": "test",
    "ClusterId": "5ffc5895-****-b03a-c223c6c3****",
    "SlbId": "lb-bp****ck3s3b9xs6x****",
    "HealthCheckUrl": "http://127.0.0.1:8080/xyz.html",
    "ApplicationType": "FatJar",
    "ExtSlbId": "lb-bp1vceck3s3b9xs6x****",
    "RegionId": "cn-hangzhou",
    "BuildPackageId": 59,
    "Email": "xxxx@gmail.com",
    "Cpu": 1,
    "ClusterType": "2",
    "SlbName": "test",
    "EnableUrlCheck": false,
    "EnablePortCheck": false,
    "AppPhase": "ready",
    "HaveManageAccess": "",
    "WorkloadType": ""
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-09-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-05-22The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-06-28The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.