Querying the Instance Execution Status
Function
This API is used to query the instance statuses of the current day, previous day, the day before the previous day, and last seven days.
URI
- URI format
GET /v2/{project_id}/factory/monitor/task-statistics-overview?is_own={is_own}&query_days={query_days}
- Parameter description
Table 1 URI parameters Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
is_own
No
String
Whether to query the statuses of the current user's instances. The default value is false, indicating that the statuses of all users' instances will be queried. Value true indicates that the statuses of the current user's instances will be queried.
query_days
No
String
Number of days for query. The value can be today, yesterday, before_yesterday, or all. The default value is today, indicating that instance statuses of the current day will be queried.
today: Instance statuses of the current day will be queried.
yesterday: Instance statuses of yesterday will be queried.
before_yesterday: Instance statuses of the day before yesterday will be queried.
all: Instance statuses of the last seven days will be queried.
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
workspace |
No |
String |
Workspace ID
|
X-Auth-Token |
No |
String |
IAM Token Minimum length: 0 Maximum length: 4096 |
Response Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fail_count |
No |
Integer |
Number of failed instances |
force_success_count |
No |
Integer |
Number of instances that were forced to be successful |
freeze_count |
No |
Integer |
Number of frozen instances |
ignore_success_count |
No |
Integer |
Number of instances whose failures were ignored |
manual_stop_count |
No |
Integer |
Number of canceled instances |
pause_count |
No |
Integer |
Number of paused instances |
running_count |
No |
Integer |
Number of running instances |
running_exception_count |
No |
Integer |
Number of abnormal instances |
skip_count |
No |
Integer |
Number of skipped instances |
success_count |
No |
Integer |
Number of successful instances |
waiting_confirm_count |
No |
Integer |
Number of instances to be confirmed for execution |
waiting_count |
No |
Integer |
Number of instances waiting to be executed |
total_count |
No |
Integer |
Total number of instances |
Example Request
GET /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/monitor/task-statistics-overview?is_own=false&query_days=today
Example Response
- Success response
{ "fail_count": 0, "force_success_count": 0, "freeze_count": 0, "ignore_success_count": 0, "manual_stop_count": 0, "pause_count": 0, "running_count": 0, "running_exception_count": 0, "skip_count": 0, "success_count": 1, "total_count": 1, "waiting_confirm_count": 0, "waiting_count": 0 }
- Failure response
{ "error_code": "DLF.21113", "error_msg": "The task query parameters [today2] are incorrect. Currently, the supported types of parameters are today, yesterday, before_yesterday, and all." }
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