GetApplication - 获取应用信息

获取ECS集群中指定应用的信息。 。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadApplicationRead
  • EDAS
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

请求参数

名称类型必填描述示例值
AppIdstring

应用ID。

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

返回参数

名称类型描述示例值
object

接口响应。

Codeinteger

code码。

200
Messagestring

附加信息。

success
RequestIdstring

请求ID。

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

应用信息。

ExtSlbIpstring

应用绑定的公网SLB的IP。

47.114.xxx.xx
Ownerstring

应用创建者。

ouou@117274586608****
SlbPortinteger

应用绑定的私网SLB的端口。

80
NameSpacestring

应用所属的命名空间。

doc-test
ExtSlbNamestring

应用绑定的公网SLB的名称。

aa8eee383db084f42aebc4d9f52c****
CreateTimelong

应用创建时间的时间戳。

1610550324226
UserIdstring

云账号ID。

test@dd******
Portinteger

应用的服务端口。

8080
RunningInstanceCountinteger

运行的应用实例数。

1
SlbIpstring

应用绑定的私网SLB的IP。

192.168.0.100
Dockerizeboolean

是否为Docker应用:

  • false:非Docker应用。
  • true:Docker应用。
false
Descriptionstring

应用描述。

test
InstanceCountinteger

应用包含的实例数。

1
AppIdstring

应用ID。

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

应用绑定的私网SLB的信息。

test
Memoryinteger

应用实例内存配置大小,单位为MB。

0
Namestring

应用名称。

test
ClusterIdstring

应用部署的ECS集群ID。

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

应用绑定的私网SLB的ID。

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

应用的健康检查URL

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

应用部署类型:

  • War:WAR包部署。
  • FatJar:JAR包部署。
  • 空:未部署。
FatJar
ExtSlbIdstring

应用绑定的公网SLB的ID。

lb-bp1vceck3s3b9xs6x****
RegionIdstring

应用所属地域的ID。

cn-hangzhou
BuildPackageIdlong

容器版本ID。

59
Emailstring

电子邮箱地址。

xxxx@gmail.com
Cpuinteger

CPU核数。

1
ClusterTypestring

应用集群环境类型:

  • 0:普通Docker集群。
  • 1:Swarm 集群。
  • 2:ECS集群。
  • 3:Kubernetes集群。
  • 4:Pandora自动注册应用集群。
2
SlbNamestring

应用绑定的私网SLB的名称。

test
EnableUrlCheckboolean

是否开启了URL健康检查:

  • true:启用。
  • false:不启用。

若启用,则在应用启动过程中,EDAS将尝试探测指定的URL,如果访问正常,则认为应用已经启动。

false
EnablePortCheckboolean

是否开启了端口健康检查:

  • true:启用。
  • false:不启用。

若启用,在应用启动过程中,EDAS将检查端口是否存在,若存在,则认为应用已经启动。

false
AppPhasestring

K8s应用当前所属状态,用于判断应用是否处于稳定状态,处于不稳定状态时,禁止相关的配置操作:

  • ready:应用处于就绪状态,可以进行应用变更。
  • progressing:应用变更中。
  • pending:应用变更被阻塞。
  • failed:应用变更失败。

其中ready为稳定状态,其它状态为不稳定状态。

ready

示例

正常返回示例

JSON格式

{
  "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": true,
    "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": true,
    "EnablePortCheck": true,
    "AppPhase": "ready"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-06-28OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 企业级分布式应用服务 EDAS 相关技术圈