Obtaining the Component Instance List
Function
This API is used to obtain the component instance list.
URI
GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/instances
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token.
Maximum characters: 16,384 |
X-Enterprise-Project-ID |
No |
String |
Enterprise project ID.
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.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
api_version |
String |
API version. Fixed value: v1. Enumerated values:
|
kind |
String |
API type. Fixed value: ComponentConfiguration. Enumerated value:
|
items |
Array of Instance objects |
Component instance list. |
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" } ] }
Status Code
Status Code |
Description |
---|---|
200 |
The request is successful. |
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot