Obtaining the Component Instance List

Updated on 2025-02-14 GMT+08:00

View PDF

Function

This API is used to obtain the component instance list.

URI

GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/instances

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. See Obtaining a Project ID.
application_id	Yes	String	Application ID.
component_id	Yes	String	Component ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. Maximum characters: 16,384
X-Enterprise-Project-ID	No	String	Enterprise project ID. When an environment is created, it will be bound with an enterprise project ID. Enter 0 or up to 36 characters in UUID format with hyphens (-). If this parameter is not specified or set to 0, resources in the default enterprise project are queried. NOTE: For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
api_version	String	API version. Fixed value: v1. Enumerated values: v1
kind	String	API type. Fixed value: ComponentConfiguration. Enumerated value: ComponentConfiguration
items	Array of Instance objects	Component instance list.

**Table 4** Instance
Parameter	Type	Description
id	String	Instance ID.
name	String	Instance name.
status	String	Instance status. Enumerated values: creating running abnormal failed terminating

Example Request

Obtain the component instance list.

GET https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/instances

Example Response

Status code: 200

The request is successful.

{
  "api_version" : "v1",
  "kind" : "ComponentInstance",
  "items" : [ {
    "id" : "d59a645b-730d-4a1a-951f-822a71dcdb9d",
    "name" : "test-image-5787bf845c-wzz99",
    "status" : "creating"
  } ]
}