Help Center> Application Performance Management> API Reference> APIs> Querying the Service Instance List
View PDF

Querying the Service Instance List

Function

This API is used to query the instance list of a specified service.

URI

GET /v1/{project_id}/ats/applications/{application}/instances

Request

Request headers

Table 1 describes the request headers.

Table 1 Request headers

Parameter

Description

Mandatory

Example

clusterId

Cluster ID.

No

default

namespace

Namespace.

No

manage

Path parameters

Table 2 describes the path parameters.

Table 2 Path parameters

Parameter

Type

Description

project_id

String

Project ID.

application

String

Service name.

Request parameters

Table 3 describes the request parameter.

Table 3 Request parameter

Parameter

Mandatory

Type

Description

monitorGroup

No

String

Application name. For details, see Querying the Application List.

Example request

/v1/0/ats/applications/ams-metric:8080/instances?monitorGoup=11d5c9b83c1b2e04579fa5a34d191bb5

Response

Response parameters

Table 4 describes the response parameters.

Table 4 Response parameters

Parameter

Type

Description

errorCode

String

Error code.

SVCSTG.ATS.2000: Query succeeded.

SVCSTG.ATS.400101: Parameter verification failed.

SVCSTG.ATS.200103: No instance information found.

errorMessage

String

Description of the error.

responseInfo

List (string)

Instance list of a specified service.

Example response

{
  "errorCode": "SVCSTG.ATS.2000",
  "errorMessage":null,
  "responseInfo": [ "d056db8ebf2350c118ea7ace383ac5dd"]
}

Status Code

  • Success response
    Table 5 describes the status code.
    Table 5 Status code

    Status Code

    Description

    200

    The request is successful.
Parent topic: APIs