API Reference Appendix

Allowed API requests in each case of configuration_status and operation_status

configuration_status operation_status Allowed API Requests
ACTIVE NONE (No transition to this status)
PROCESSING -
STUCK -
COMPLETE
  • PATCH /v1.0/<resource>/<id>
  • DELETE /v1.0/<resource>/<id>
  • POST /v1.0/<resource>/<id>/staged
  • POST /v1.0/load_balancers/<id>/action
ERROR
  • PATCH /v1.0/<resource>/<id>
  • DELETE /v1.0/<resource>/<id>
  • POST /v1.0/<resource>/<id>/staged
  • POST /v1.0/load_balancers/<id>/action
CREATE_STAGED NONE
  • PATCH /v1.0/<resource>/<id>
  • DELETE /v1.0/<resource>/<id>
  • PATCH /v1.0/<resource>/<id>/staged
  • DELETE /v1.0/<resource>/<id>/staged
  • POST /v1.0/load_balancers/<id>/action
PROCESSING -
STUCK -
COMPLETE
  • PATCH /v1.0/<resource>/<id>
  • DELETE /v1.0/<resource>/<id>
  • PATCH /v1.0/<resource>/<id>/staged
  • DELETE /v1.0/<resource>/<id>/staged
  • POST /v1.0/load_balancers/<id>/action
ERROR
  • PATCH /v1.0/<resource>/<id>
  • DELETE /v1.0/<resource>/<id>
  • PATCH /v1.0/<resource>/<id>/staged
  • DELETE /v1.0/<resource>/<id>/staged
  • POST /v1.0/load_balancers/<id>/action
UPDATE_STAGED NONE (No transition to this status)
PROCESSING -
STUCK -
COMPLETE
  • PATCH /v1.0/<resource>/<id>
  • DELETE /v1.0/<resource>/<id>
  • PATCH /v1.0/<resource>/<id>/staged
  • DELETE /v1.0/<resource>/<id>/staged
  • POST /v1.0/load_balancers/<id>/action
ERROR
  • PATCH /v1.0/<resource>/<id>
  • DELETE /v1.0/<resource>/<id>
  • PATCH /v1.0/<resource>/<id>/staged
  • DELETE /v1.0/<resource>/<id>/staged
  • POST /v1.0/load_balancers/<id>/action
DELETE_STAGED NONE (No transition to this status)
PROCESSING -
STUCK -
COMPLETE
  • DELETE /v1.0/<resource>/<id>/staged
ERROR
  • DELETE /v1.0/<resource>/<id>/staged

Transition of configuration_status by API request

API Request Method / Path configuration_status Before HTTP Response Code configuration_status After Note
POST /v1.0/<resource> - 200 CREATE_STAGED  
PATCH /v1.0/<resource>/<id> ACTIVE 200 ACTIVE  
CREATE_STAGED 200 CREATE_STAGED  
UPDATE_STAGED 200 UPDATE_STAGED  
DELETE_STAGED 400 DELETE_STAGED  
DELETE /v1.0/<resource>/<id> ACTIVE 204 - Delete immediately if <resource> is load_balancers
DELETE_STAGED  
CREATE_STAGED 204 - Cancel resource creation
UPDATE_STAGED 204 - Delete immediately if <resource> is load_balancers
DELETE_STAGED Cancel resource update
DELETE_STAGED 400 DELETE_STAGED  
POST /v1.0/<resource>/<id>/staged ACTIVE 200 UPDATE_STAGED  
CREATE_STAGED 400 CREATE_STAGED  
UPDATE_STAGED 400 UPDATE_STAGED  
DELETE_STAGED 400 DELETE_STAGED  
PATCH /v1.0/<resource>/<id>/staged ACTIVE 400 ACTIVE  
CREATE_STAGED 200 CREATE_STAGED  
UPDATE_STAGED 200 UPDATE_STAGED  
DELETE_STAGED 400 DELETE_STAGED  
DELETE /v1.0/<resource>/<id>/staged ACTIVE 400 ACTIVE  
CREATE_STAGED 204 - Cancel resource creation
UPDATE_STAGED 204 ACTIVE Cancel resource update
DELETE_STAGED 204 ACTIVE Cancel resource deletion
POST /v1.0/load_balancers/<id>/action
("apply-configurations" is specified)
 ACTIVE 204 ACTIVE  
CREATE_STAGED 204 ACTIVE  
UPDATE_STAGED 204 ACTIVE  
DELETE_STAGED 204 - Except load balancers

Transition of values of resource attributes by apply-configurations Action

  • Root of JSON : Value that was applied to your instance by a past "apply-configurations" action.
  • "current" : Always the same value as the root of JSON.
  • "staged" : Values that will be applied to your instance by a "apply-configurations" action.
configuration_status Before Value of Attributes Before Action (in Response Body of Show API) Value of Attributes After Action (in Response Body of Show API)
in Root of JSON in "current" in "staged" in Root of JSON in "current" in "staged"
CREATE_STAGED null null Specified value in past API requests Specified value in past API requests Same as root of JSON null
null null null Default value Same as root of JSON null
UPDATE_STAGED Value that was applied to your instance by a past "apply-configurations" action Same as root of JSON Specified value in past API requests Specified value in past API requests Same as root of JSON null
Value that was applied to your instance by a past "apply-configurations" action Same as root of JSON null Value that was applied to your instance by a past "apply-configurations" action Same as root of JSON null