DescribeAppInstanceList - 查询K8s应用实例列表

调用DescribeAppInstanceList接口查询K8s应用实例列表。

调试

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

调试

授权信息

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

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

请求语法

GET /pop/v5/oam/app_instance_list

请求参数

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

应用 ID,可通过调用 ListApplication 接口获取。更多信息,请参见 ListApplication

93fdd228-*****-ed2ae98de18d
WithNodeInfoboolean

是否返回 Pod 所在的节点信息。

  • true:是
  • false:否
true

返回参数

名称类型描述示例值
object
Codeinteger

接口状态或 POP 错误码。

200
Messagestring

返回信息。

success
RequestIdstring

请求 ID。

03FD1520-0FD6-436A-****-265318D7****
InstanceListobject []

应用实例列表。

NodeLabelsstring

节点标签,内容为 JSON 格式字符串。

{"alibabacloud.com/nodepool-id":"np0*5b9377fa907","beta.kubernetes.io/arch":"amd64","beta.kubernetes.io/instance-type":"ecs.*","beta.kubernetes.io/os":"linux","failure-domain.beta.kubernetes.io/region":"cn-hangzhou","failure-domain.beta.kubernetes.io/zone":"cn-hangzhou-b","kubernetes.io/arch":"amd64","kubernetes.io/hostname":"cn-hangzhou*","kubernetes.io/os":"linux","node.kubernetes.io/instance-type":"ecs.*","topology.diskplugin.csi.alibabacloud.com/zone":"cn-hangzhou-b","topology.kubernetes.io/region":"cn-hangzhou","topology.kubernetes.io/zone":"cn-hangzhou-b"}
GroupIdstring

部署分组 ID。

93fdd228-*****-ed2ae98de18d
GroupNamestring

部署分组名。

_DEFAULT_GROUP
Canaryboolean

是否是金丝雀发布实例。

  • true:是
  • false:否
false
NodeNamestring

节点名称。

cn-hangzhou.192.168.0.*
PodRawstring

Pod 信息,内容为 JSON 格式字符串。

{"metadata":{"name":"oambuild-group-1-*4xthz","generateName":"oambuild-group-*96-","namespace":"default","selfLink":"/api/v1/namespaces/default/pods/oambuild-grou*96-4xthz","uid":"7a23399c-*fe7ff4018","resourceVersion":"969614830","creationTimestamp":"2021-04-06T11:38:46Z","labels":{"ARMSApmAppId":"*","ARMSApmLicenseKey":"*"...
Versionstring

节点部署的包版本。

2021-04-06 19:37:42
AppIdstring

应用 ID。

93fdd228-*****-ed2ae98de18d

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "03FD1520-0FD6-436A-****-265318D7****",
  "InstanceList": [
    {
      "NodeLabels": "{\"alibabacloud.com/nodepool-id\":\"np0*5b9377fa907\",\"beta.kubernetes.io/arch\":\"amd64\",\"beta.kubernetes.io/instance-type\":\"ecs.*\",\"beta.kubernetes.io/os\":\"linux\",\"failure-domain.beta.kubernetes.io/region\":\"cn-hangzhou\",\"failure-domain.beta.kubernetes.io/zone\":\"cn-hangzhou-b\",\"kubernetes.io/arch\":\"amd64\",\"kubernetes.io/hostname\":\"cn-hangzhou*\",\"kubernetes.io/os\":\"linux\",\"node.kubernetes.io/instance-type\":\"ecs.*\",\"topology.diskplugin.csi.alibabacloud.com/zone\":\"cn-hangzhou-b\",\"topology.kubernetes.io/region\":\"cn-hangzhou\",\"topology.kubernetes.io/zone\":\"cn-hangzhou-b\"}",
      "GroupId": "93fdd228-*****-ed2ae98de18d",
      "GroupName": "_DEFAULT_GROUP",
      "Canary": false,
      "NodeName": "cn-hangzhou.192.168.0.*",
      "PodRaw": "{\"metadata\":{\"name\":\"oambuild-group-1-*4xthz\",\"generateName\":\"oambuild-group-*96-\",\"namespace\":\"default\",\"selfLink\":\"/api/v1/namespaces/default/pods/oambuild-grou*96-4xthz\",\"uid\":\"7a23399c-*fe7ff4018\",\"resourceVersion\":\"969614830\",\"creationTimestamp\":\"2021-04-06T11:38:46Z\",\"labels\":{\"ARMSApmAppId\":\"*\",\"ARMSApmLicenseKey\":\"*\"...",
      "Version": "2021-04-06 19:37:42",
      "AppId": "93fdd228-*****-ed2ae98de18d"
    }
  ]
}

错误码

HTTP status code错误码错误信息
400Edas.errorcode.PermissionDenied.messageNo permissions
400Edas.errorcode.ParameterMissing.AppId.messageApplication ID is missing.

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