Delivering an Add-on Job Based on the Add-on ID
Function
This API is used to deliver an add-on job based on the add-on ID.
URI
POST /v3/{project_id}/cas/environments/{environment_id}/addons/{addon_id}/action
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant's project ID. See Obtaining a Project ID. |
environment_id |
Yes |
String |
Environment ID. See Obtaining All Environments. |
addon_id |
Yes |
String |
Add-on ID. See Querying the Add-on List. |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
Yes |
String |
Add-on job type.
|
Response
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Job ID. |
Example Request
Deliver an add-on redeployment job.
{ "action": "redeploy" }
Example Response
{ "job_id": "JOB7e9317bb-a63a-46f4-a026-244de2f6eac3" }
Status Code
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
Error Code
The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage 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