Obtaining the Operations Allowed in a Specified Task
Function
This API is used to obtain information about allowed, not allowed, and current operations of a specified task.
Constraints
This API can be used only in certain regions. For details, see Endpoints.
URI
GET /v5/{project_id}/jobs/{job_id}/actions
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID of a tenant in a region. For details, see Obtaining a Project ID. |
|
job_id |
Yes |
String |
Task ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
Content-Type |
Yes |
String |
MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. The default value is application/json. |
|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a request is processed, the value of X-Subject-Token in the header is the token value. |
|
X-Language |
No |
String |
Request language type. Default value: en-us Enumerated values:
|
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
job_action |
Object |
Collection of allowed and not allowed operations. For details, see Table 4. |
|
Parameter |
Type |
Description |
|---|---|---|
|
available_actions |
Array of strings |
The collection of operation commands that can be executed for a task. The value can be:
|
|
unavailable_actions |
Array of strings |
The collection of operation commands that cannot be executed for a task. The value can be:
|
|
current_action |
String |
The current operation. |
Status code: 422
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. Minimum length: 12 Maximum length: 12 |
|
error_msg |
String |
Error message. Minimum length: 1 Maximum length: 512 |
Example Request
Obtaining the operation information about a specified task
https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/actions
Example Response
Status code: 200
{
"job_action": {
"available_actions": [
"CREATE",
"CHOOSE_OBJECT",
"PRE_CHECK"
],
"unavailable_actions": [
"START",
"QUICK_START",
"CHANGE",
"RETRY"
],
"current_action": "SWITCH_OVER"
}
}
Status code: 400
Bad Request
{
"error_code": "DRS.10000001",
"error_msg": "Failed."
}
Error Code
For details, see 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
