GetK8sApplication - 获取K8s应用信息

获取容器服务K8s集群或Serverless K8s集群中部署的应用信息。

调试

您可以在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,可通过调用ListApplication接口获取,详情请参见ListApplication

5a166fbd-****-4f98-a286-781659d9****
Fromstring

查询来源:

  • 为空表示普通查询。
  • deploy表示从部署页面进入查询。
deploy

返回参数

名称类型描述示例值
object

接口响应。

Codeinteger

接口状态或POP错误码。

200
Messagestring

附加信息。

success
RequestIdstring

请求ID。

1053-08e4-47a5-b2ab-5c0323de7b5a
Applcationobject

应用信息。

AppIdstring

应用ID,可通过调用ListApplication接口来获取,详情请参见ListApplication

a5281053-****-47a5-b2ab-5c0323de****
DeployGroupsarray

部署分组列表。

object

部署分组对象。

Componentsarray

组件信息。

object

组件对象。

Typestring

组件类型。

JDK
ComponentKeystring

组件关键字。

Open JDK 8
ComponentIdstring

组件ID。

5
Envstring

环境变量,相对于EnvList字段,本字段透出对ConfigMap/Secret引用的相关配置信息。

"["{\"name\":\"test1\",\"valueFrom\":{\"configMapKeyRef\":{\"name\":\"edas-demo-configmap\",\"key\":\"key1\"}}}","{\"name\":\"k2\",\"value\":\"v2\"}","{\"name\":\"s1\",\"valueFrom\":{\"secretKeyRef\":{\"name\":\"edas-demo-secret\",\"key\":\"k1\"}}}"]"
EnvFromstring

环境变量来源。

[{"configMapRef":{"name":"test-cm"}}]
ImageInfoobject

镜像信息。

RepoIdstring

镜像仓库ID。

cn-hangzhou
ImageUrlstring

镜像URL。

registry.cn-beijing.aliyuncs.com/edas-serverless-****/1314839****06888_shared_repo:5a166fbd-9d76-4f98-****-78165****c_1572***282
RepoOriginTypestring

镜像仓库来源类型。

ALI_HUB
Tagstring

镜像Tag。

5a166fbd-9d76-4f98-****-781659d9f54c_1572485443282
RepoNamestring

镜像仓库名称。

131****067006888_shared_repo
RepoNamespacestring

镜像仓库命名空间。

edas-server****-user
RegionIdstring

镜像地域ID。

cn-beijing
Appobject

应用基础信息。

RequestMeminteger

内存资源预留,单位MiB。

1024
InstancesBeforeScalinginteger

上次伸缩前的应用实例数。

10
DeployTypestring

部署类型,可选值为:Image。

Image
ApplicationNamestring

应用名称。

test
ApplicationTypestring

应用类型。

War
Instancesinteger

应用实例数。

4
LimitMeminteger

内存资源限制,单位MiB。

1024
Cmdstring

启动命令。

ls
RegionIdstring

地域ID。

cn-hangzhou
BuildpackIdinteger

应用构建类型ID。

57
TomcatVersionstring

Apache Tomcat版本。

8.5.55
CsClusterIdstring

容器集群ID。

c383bc813c1974e****451b50c0c8****
RequestCpuMinteger

CPU资源请求,单位为毫核,1000为1核CPU。

1000
AppIdstring

应用ID,可通过调用ListApplication接口获取,详情请参见ListApplication

00ee517d-dd7d-4d4e-****-****
K8sNamespacestring

K8s命名空间。

default
EdasContainerVersionstring

EDAS容器版本。

3.60.0
LimitCpuMinteger

CPU资源限制,单位为毫核,1000为1核CPU。

1000
ClusterIdstring

集群ID。

c37aec2a-bcca-4ec1-****-****
EnvListarray

环境变量列表。

object

环境变量对象。

Namestring

环境变量名称。

CATALINA_OPTS
Valuestring

环境变量值。

-Xmx 1024m -Dhsf.default.tid=false $(EDAS_CATALINA_OPTS)
CmdArgsarray

命令列表。

string

命令参数。

-lh
DevelopTypestring

应用类型:

  • General - 原生Java应用。
  • Pandora - Pandora应用。
  • Multilingual - 多语言应用。
General
SlbInfostring

SLB配置信息。

[ { "addressType": "intranet", "externalTrafficPolicy": "Local", "ip": "192.168.254.***", "name": "intranet-testapp", "portMappings": [ { "loadBalancerProtocol": "TCP", "servicePort": { "port": 8080, "protocol": "TCP", "targetPort": 18081, "vServerGroupName": "k8s/31414/intranet-testapp/default/cc90e0c9508a44667bdae2e83d3******" } } ], "scheduler": "rr", "serviceType": "LoadBalancer", "slbId": "lb-bp1ikoh3nrpgqsm******", "source": "create", "specification": "slb.s3.large" } ]
Annotationsstring

应用Pod注解。

{"test-annokey":"test-annovalue"}
Labelsstring

应用Pod标签。

{"test-labelkey":"test-labelvalue"}
LimitEphemeralStoragestring

临时存储资源需求上限,单位:GB。设置0表示不限制。

4
RequestEphemeralStoragestring

临时存储资源需求预留,单位:GB。设置0表示不限制。

2
Confobject

配置信息。

PostStartstring

K8s容器启动后执行信息。

{\"exec\":{\"command\":[\"ls\",\"/\"]}}"
Readinessstring

K8s容器业务状态检查信息。

{"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": \[{"name": "test","value": "testvalue"}\]}}
AhasEnabledboolean

应用是否已接入AHAS。

true
K8sCmdArgsstring

启动命令参数。

-lh
Livenessstring

K8s容器存活状态监测信息。

{"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"tcpSocket":{"host":"", "port":8080}}
DeployAcrossNodesstring

是否将应用实例分布到多节点:

  • true代表是。
  • 其他值代表否。
true
K8sCmdstring

启动命令。

ls
PreStopstring

K8s容器停止前执行信息。

{\"exec\":{\"command\":[\"ls\",\"/\"]}}"
DeployAcrossZonesstring

是否将应用实例分布到多可用区:

  • true代表是。
  • 其他值代表否。
true
JarStartArgsstring

JAR启动参数,已废弃。

-lh
K8sNasInfostring

NAS存储信息。

[{"nasPath":"/mnt/","mountPath":"/mnt/"}]
JarStartOptionsstring

JAR启动选项,已废弃。

-h
RuntimeClassNamestring

容器运行时类型,仅适用于使用安全沙箱容器的集群。

runc
K8sLocalvolumeInfostring

本地存储信息。

[{"type":"","nodePath":"/mnt/","mountPath":"/mnt/"}]
K8sVolumeInfostring

存储信息。

"{\"hostPaths\":\"[]\",\"emptyDirs\":\"[]\"}"
Affinitystring

Pod亲和性配置。

"{\"nodeAffinity\":{\"requiredDuringSchedulingIgnoredDuringExecution\":{\"nodeSelectorTerms\":[{\"matchExpressions\":[{\"key\":\"beta.kubernetes.io/arch\",\"operator\":\"NotIn\",\"values\":[\"arm64\",\"arm32\"]}]}]},\"preferredDuringSchedulingIgnoredDuringExecution\":[{\"weight\":5,\"preference\":{\"matchExpressions\":[{\"key\":\"kubernetes.io/os\",\"operator\":\"In\",\"values\":[\"linux\"]}]}}]},\"podAffinity\":{\"requiredDuringSchedulingIgnoredDuringExecution\":[{\"labelSelector\":{\"matchExpressions\":[{\"key\":\"edas.oam.acname\",\"operator\":\"NotIn\",\"values\":[\"edas-test-app\"]}]},\"namespaces\":[\"default\"],\"topologyKey\":\"kubernetes.io/hostname\"}]},\"podAntiAffinity\":{\"preferredDuringSchedulingIgnoredDuringExecution\":[{\"weight\":15,\"podAffinityTerm\":{\"labelSelector\":{\"matchExpressions\":[{\"key\":\"edas.oam.acname\",\"operator\":\"In\",\"values\":[\"edas-test-app-2\"]}]},\"namespaces\":[\"default\"],\"topologyKey\":\"failure-domain.beta.kubernetes.io/zone\"}}]}}"
Tolerationsstring

Pod调度容忍配置。

"[{\"key\":\"edas-taint-key2\",\"operator\":\"Exists\",\"effect\":\"NoExecute\",\"tolerationSeconds\":50},{\"key\":\"edas-taint-key\",\"operator\":\"Equal\",\"value\":\"edas-taint-value\",\"effect\":\"PreferNoSchedule\"}]"
LatestVersionobject

最新版本信息。

Urlstring

部署包地址。通过FatJar或WAR包部署的应用需要配置部署包地址。

https://e***.oss-cn-beijing.aliyuncs.com/s***-1.0-SNAPSHOT-spring-boot.jar
WarUrlstring

部署包地址。通过FatJar或WAR包部署的应用需要配置部署包地址。

https://e***.oss-cn-beijing.aliyuncs.com/s***-1.0-SNAPSHOT-spring-boot.jar
PackageVersionstring

部署包的版本号。

20200720

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "1053-08e4-47a5-b2ab-5c0323de7b5a",
  "Applcation": {
    "AppId": "a5281053-****-47a5-b2ab-5c0323de****",
    "DeployGroups": [
      {
        "Components": [
          {
            "Type": "JDK",
            "ComponentKey": "Open JDK 8",
            "ComponentId": "5"
          }
        ],
        "Env": "\"[\"{\\\"name\\\":\\\"test1\\\",\\\"valueFrom\\\":{\\\"configMapKeyRef\\\":{\\\"name\\\":\\\"edas-demo-configmap\\\",\\\"key\\\":\\\"key1\\\"}}}\",\"{\\\"name\\\":\\\"k2\\\",\\\"value\\\":\\\"v2\\\"}\",\"{\\\"name\\\":\\\"s1\\\",\\\"valueFrom\\\":{\\\"secretKeyRef\\\":{\\\"name\\\":\\\"edas-demo-secret\\\",\\\"key\\\":\\\"k1\\\"}}}\"]\"",
        "EnvFrom": "[{\"configMapRef\":{\"name\":\"test-cm\"}}]"
      }
    ],
    "ImageInfo": {
      "RepoId": "cn-hangzhou",
      "ImageUrl": "registry.cn-beijing.aliyuncs.com/edas-serverless-****/1314839****06888_shared_repo:5a166fbd-9d76-4f98-****-78165****c_1572***282",
      "RepoOriginType": "ALI_HUB",
      "Tag": "5a166fbd-9d76-4f98-****-781659d9f54c_1572485443282",
      "RepoName": "131****067006888_shared_repo",
      "RepoNamespace": "edas-server****-user",
      "RegionId": "cn-beijing"
    },
    "App": {
      "RequestMem": 1024,
      "InstancesBeforeScaling": 10,
      "DeployType": "Image",
      "ApplicationName": "test",
      "ApplicationType": "War",
      "Instances": 4,
      "LimitMem": 1024,
      "Cmd": "ls",
      "RegionId": "cn-hangzhou",
      "BuildpackId": 57,
      "TomcatVersion": "8.5.55",
      "CsClusterId": "c383bc813c1974e****451b50c0c8****",
      "RequestCpuM": 1000,
      "AppId": "00ee517d-dd7d-4d4e-****-****",
      "K8sNamespace": "default",
      "EdasContainerVersion": "3.60.0",
      "LimitCpuM": 1000,
      "ClusterId": "c37aec2a-bcca-4ec1-****-****",
      "EnvList": [
        {
          "Name": "CATALINA_OPTS",
          "Value": "-Xmx 1024m -Dhsf.default.tid=false $(EDAS_CATALINA_OPTS)"
        }
      ],
      "CmdArgs": [
        "-lh"
      ],
      "DevelopType": "General",
      "SlbInfo": "[\n  {\n    \"addressType\": \"intranet\",\n    \"externalTrafficPolicy\": \"Local\",\n    \"ip\": \"192.168.254.***\",\n    \"name\": \"intranet-testapp\",\n    \"portMappings\": [\n      {\n        \"loadBalancerProtocol\": \"TCP\",\n        \"servicePort\": {\n          \"port\": 8080,\n          \"protocol\": \"TCP\",\n          \"targetPort\": 18081,\n          \"vServerGroupName\": \"k8s/31414/intranet-testapp/default/cc90e0c9508a44667bdae2e83d3******\"\n        }\n      }\n    ],\n    \"scheduler\": \"rr\",\n    \"serviceType\": \"LoadBalancer\",\n    \"slbId\": \"lb-bp1ikoh3nrpgqsm******\",\n    \"source\": \"create\",\n    \"specification\": \"slb.s3.large\"\n  }\n]",
      "Annotations": "{\"test-annokey\":\"test-annovalue\"}",
      "Labels": "{\"test-labelkey\":\"test-labelvalue\"}",
      "LimitEphemeralStorage": "4",
      "RequestEphemeralStorage": "2"
    },
    "Conf": {
      "PostStart": "{\\\"exec\\\":{\\\"command\\\":[\\\"ls\\\",\\\"/\\\"]}}\"",
      "Readiness": "{\"failureThreshold\": 3,\"initialDelaySeconds\": 5,\"successThreshold\": 1,\"timeoutSeconds\": 1,\"httpGet\": {\"path\": \"/consumer\",\"port\": 8080,\"scheme\": \"HTTP\",\"httpHeaders\": \\[{\"name\": \"test\",\"value\": \"testvalue\"}\\]}}",
      "AhasEnabled": true,
      "K8sCmdArgs": "-lh",
      "Liveness": "{\"failureThreshold\": 3,\"initialDelaySeconds\": 5,\"successThreshold\": 1,\"timeoutSeconds\": 1,\"tcpSocket\":{\"host\":\"\", \"port\":8080}}",
      "DeployAcrossNodes": "true",
      "K8sCmd": "ls",
      "PreStop": "{\\\"exec\\\":{\\\"command\\\":[\\\"ls\\\",\\\"/\\\"]}}\"",
      "DeployAcrossZones": "true",
      "JarStartArgs": "-lh",
      "K8sNasInfo": "[{\"nasPath\":\"/mnt/\",\"mountPath\":\"/mnt/\"}]",
      "JarStartOptions": "-h",
      "RuntimeClassName": "runc",
      "K8sLocalvolumeInfo": "[{\"type\":\"\",\"nodePath\":\"/mnt/\",\"mountPath\":\"/mnt/\"}]",
      "K8sVolumeInfo": "\"{\\\"hostPaths\\\":\\\"[]\\\",\\\"emptyDirs\\\":\\\"[]\\\"}\"",
      "Affinity": "\"{\\\"nodeAffinity\\\":{\\\"requiredDuringSchedulingIgnoredDuringExecution\\\":{\\\"nodeSelectorTerms\\\":[{\\\"matchExpressions\\\":[{\\\"key\\\":\\\"beta.kubernetes.io/arch\\\",\\\"operator\\\":\\\"NotIn\\\",\\\"values\\\":[\\\"arm64\\\",\\\"arm32\\\"]}]}]},\\\"preferredDuringSchedulingIgnoredDuringExecution\\\":[{\\\"weight\\\":5,\\\"preference\\\":{\\\"matchExpressions\\\":[{\\\"key\\\":\\\"kubernetes.io/os\\\",\\\"operator\\\":\\\"In\\\",\\\"values\\\":[\\\"linux\\\"]}]}}]},\\\"podAffinity\\\":{\\\"requiredDuringSchedulingIgnoredDuringExecution\\\":[{\\\"labelSelector\\\":{\\\"matchExpressions\\\":[{\\\"key\\\":\\\"edas.oam.acname\\\",\\\"operator\\\":\\\"NotIn\\\",\\\"values\\\":[\\\"edas-test-app\\\"]}]},\\\"namespaces\\\":[\\\"default\\\"],\\\"topologyKey\\\":\\\"kubernetes.io/hostname\\\"}]},\\\"podAntiAffinity\\\":{\\\"preferredDuringSchedulingIgnoredDuringExecution\\\":[{\\\"weight\\\":15,\\\"podAffinityTerm\\\":{\\\"labelSelector\\\":{\\\"matchExpressions\\\":[{\\\"key\\\":\\\"edas.oam.acname\\\",\\\"operator\\\":\\\"In\\\",\\\"values\\\":[\\\"edas-test-app-2\\\"]}]},\\\"namespaces\\\":[\\\"default\\\"],\\\"topologyKey\\\":\\\"failure-domain.beta.kubernetes.io/zone\\\"}}]}}\"",
      "Tolerations": "\"[{\\\"key\\\":\\\"edas-taint-key2\\\",\\\"operator\\\":\\\"Exists\\\",\\\"effect\\\":\\\"NoExecute\\\",\\\"tolerationSeconds\\\":50},{\\\"key\\\":\\\"edas-taint-key\\\",\\\"operator\\\":\\\"Equal\\\",\\\"value\\\":\\\"edas-taint-value\\\",\\\"effect\\\":\\\"PreferNoSchedule\\\"}]\""
    },
    "LatestVersion": {
      "Url": "https://e***.oss-cn-beijing.aliyuncs.com/s***-1.0-SNAPSHOT-spring-boot.jar",
      "WarUrl": "https://e***.oss-cn-beijing.aliyuncs.com/s***-1.0-SNAPSHOT-spring-boot.jar",
      "PackageVersion": "20200720"
    }
  }
}

错误码

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

阿里云首页 企业级分布式应用服务 EDAS 相关技术圈