Querying a Specific Record from Background Tasks
Function
This API is used to query a specific record from background tasks.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A |
instance_id |
Yes |
String |
Definition: Instance ID. To obtain it, log in to the RocketMQ console and find the instance ID on the RocketMQ instance details page. Constraints: N/A Range: N/A Default Value: N/A |
task_id |
Yes |
String |
Definition: Task ID. Constraints: N/A Range: N/A Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_count |
String |
Definition: Number of tasks. Range: N/A |
tasks |
Array of tasks objects |
Definition: Task list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Task ID. Range: N/A |
name |
String |
Definition: Task name. Range: N/A |
user_name |
String |
Definition: Username. Range: N/A |
user_id |
String |
Definition: User ID. Range: N/A |
params |
String |
Definition: Task parameters. Range: N/A |
status |
String |
Definition: Task status. Range: N/A |
created_at |
String |
Definition: Start time. Range: N/A |
updated_at |
String |
Definition: End time. Range: N/A |
Example Requests
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}
Example Responses
Status code: 200
Successful
{ "task_count" : "1", "tasks" : [ { "id" : "ff80808272dcc90f0172df1e490f41b0", "name" : "bindInstancePublicIp", "user_name" : "dms_test", "user_id" : "xxxxxxxx93ff484a828144c6xxxxxxxx", "params" : "{\"public_ip_id\":\"06a13350-4305-4338-9f0e-6b322bb1413d\",\"public_ip_address\":\"xx.xx.xx.xx\",\"enable_public_ip\":true}", "status" : "SUCCESS", "created_at" : "2020-06-23T03:00:03.471Z", "updated_at" : "2020-06-23T03:00:08.130Z" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful |
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