Queries Kubernetes application instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see the topic about common request parameters.

Request syntax

GET /pop/v5/oam/app_instance_list HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
AppId String Query Yes 93fdd228-*****-ed2ae98de18d

The ID of the application. You can call the ListApplication operation to query the ID of the application. For more information, see ListApplication.

WithNodeInfo Boolean Query No true

Specifies whether to return the information about the node in which the pod resides.

  • true: yes.
  • false: no.

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP status code.

InstanceList Array of Instance

The application instances.

AppId String 93fdd228-*****-ed2ae98de18d

The ID of the application.

Canary Boolean false

Indicates whether the application was released in canary release mode.

  • true: yes.
  • false: no.
GroupId String 93fdd228-*****-ed2ae98de18d

The ID of the group to which the application was deployed.

GroupName String _DEFAULT_GROUP

The name of the group to which the application was deployed.

NodeLabels String null

The labels of the node. The value is a JSON string.

NodeName String cn-hangzhou.192.168.0.*

The name of the node.

PodRaw String {"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":"*"...

The information about the pod. The value is a JSON string.

Version String 2021-04-06 19:37:42

The deployment package version of the node.

Message String success

The returned message that indicates whether the request is successful.

RequestId String 03FD1520-0FD6-436A-****-265318D7****

The ID of the request.

Examples

Sample requests

GET /pop/v5/oam/app_instance_list HTTP/1.1
Common request headers
{
"AppId": "93fdd228-*****-ed2ae98de18d"
}

Sample success responses

XML format

<DescribeAppInstanceListResponse>
  <Message>success</Message>
  <RequestId>03FD1520-0FD6-436A-****-265318D7****</RequestId>
  <InstanceList>
        <GroupName>_DEFAULT_GROUP</GroupName>
        <AppId>93fdd228-*****-ed2ae98de18d</AppId>
        <NodeName>cn-hangzhou.192.168.0.*</NodeName>
        <Version>2021-04-06 19:37:42</Version>
        <Canary>false</Canary>
        <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"}</NodeLabels>
        <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":"*"...</PodRaw>
        <GroupId>93fdd228-*****-ed2ae98de18d</GroupId>
  </InstanceList>
  <Code>200</Code>
</DescribeAppInstanceListResponse>

JSON format

{
    "Message": "success",
    "RequestId": "03FD1520-0FD6-436A-****-265318D7****",
    "InstanceList": {
        "GroupName": "_DEFAULT_GROUP",
        "AppId": "93fdd228-*****-ed2ae98de18d",
        "NodeName": "cn-hangzhou.192.168.0.*",
        "Version": "2021-04-06 19:37:42",
        "Canary": false,
        "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\"}",
        "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\":\"*\"...",
        "GroupId": "93fdd228-*****-ed2ae98de18d"
    },
    "Code": 200
}

Error codes

For a list of error codes, visit the API Error Center.