Obtaining the Component Instance List

Function

Obtain the component instance list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

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. Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference. The value of X-Subject-Token in the response header is the token value.
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 is set to 0, resources in the default enterprise project are queried. NOTE: For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List. 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.
kind	String	API type. Fixed 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	Definition Instance status. Constraints N/A. Range creating: The instance is being created. Pre-operations such as pulling the container image and initializing the container are being performed. The container is not ready for running. running: The instance is running properly. The instance has started, and at least one container is running properly. The overall functions meet the expectation. abnormal: The instance is not running properly. The instance status is not as expected due to reasons such as health check failures and insufficient resources (for example, insufficient CPU or memory). You need to check the event logs to locate the fault. failed: The instance fails to run. At least one container exits in a non-zero state (that is, an error occurs during running), and the entire system is unavailable. terminating: The instance is being terminated. Generally, this status is caused by user operations such as deletion and update. The instance is being stopped and its resources (such as memory and network connections) are being cleared. Default Value N/A.

Example Requests

Obtain the component instance list.

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

Example Responses

Status code: 200

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