Obtaining Records Based on the Component ID
Function
This API is used to obtain records based on the component ID.
URI
GET /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/records
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant's project ID. See Obtaining a Project ID. |
application_id |
Yes |
String |
Application ID. See Obtaining All Applications. |
component_id |
Yes |
String |
Component ID. See Obtaining All Components of an Application. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
String |
Number of records to be queried. Value range: 0–100. |
offset |
No |
String |
Offset. |
order_by |
No |
String |
Sorting field. Enumerated values:
If the transferred value is not within the supported enumerated value range, the default sorting field is used. |
order |
No |
String |
Sorting order.
|
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type (format). Default value: application/json;charset=utf8. |
X-Auth-Token |
Yes |
String |
API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication. |
Response
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number of records. |
records |
Array of objects |
Record list. See Table 5. |
Parameter |
Type |
Description |
---|---|---|
begin_time |
String |
Start time. |
end_time |
String |
End time. |
description |
Object |
Description. |
instance_id |
String |
Instance ID. |
version |
String |
Version number. |
current_used |
Boolean |
Currently used parameter. |
status |
String |
Status. |
deploy_type |
String |
Deployment type.
|
jobs |
Array of objects |
Job list. See Table 6. |
Parameter |
Type |
Description |
---|---|---|
sequence |
Integer |
Execution sequence. |
deploy_type |
String |
Deployment type.
|
job_id |
String |
Job ID. |
job_info |
Object |
Job information. See Table 7. |
Parameter |
Type |
Description |
---|---|---|
deploy_type |
String |
Deployment type. |
source_url |
String |
Component source. |
first_batch_weight |
Integer |
First execution weight. |
first_batch_replica |
Integer |
Component instances deployed first time. |
replica |
Integer |
Total instances. |
remaining_batch |
Integer |
Remaining batch. |
Example Request
None
Example Response
{ "count": 10, "records": [ { "begin_time": "string", "end_time": "string", "description": null, "instance_id": "string", "version": "string", "current_used": true, "status": "string", "deploy_type": "string", "jobs": [ { "sequence": 0, "deploy_type": "string", "job_id": "string", "job_info": { "deploy_type": "string", "source_url": "string", "first_batch_weight": 0, "first_batch_replica": 0, "replica": 0, "remaining_batch": 0 } } ] } ] }
Status Code
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
Error Code
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