Obtaining the Component Instance List
Function
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.
|
X-Enterprise-Project-ID |
No |
String |
Enterprise project ID.
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.
|
Response Parameters
Status code: 200
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. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
name |
String |
Instance name. |
status |
String |
Definition Instance status. Constraints N/A. Range
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
OK
{ "api_version" : "v1", "kind" : "ComponentInstance", "items" : [ { "id" : "d59a645b-730d-4a1a-951f-822a71dcdb9d", "name" : "test-image-5787bf845c-wzz99", "status" : "creating" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
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