Query warehouse operation status

Queries the status of the specified warehouse operation.

NOTE

This operation requires the View cluster privilege.

Request

Basic information
HTTP URL	https://cloud-api.celerdata.com/api/1.0/clusters/:cluster_id/infra-action/state
HTTP method	GET
Frequency	600/minute

Path variables

Parameter	Example value	Required	Type	Description
cluster_id	ff09d6ac-b821-447d-b4c1-59167d022c8b	Yes	String	The ID of the cluster.

URL parameters

Parameter	Example value	Required	Type	Description
order_id	9d71aae6-a35da-40d5-b213-27bb1f57ifj5	Yes	String	The order ID of the operation (action).

Header parameters

Parameter	Example value	Required	Type	Description
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	Yes	String	The access token used to access the CelerData Cloud BYOC API. Format: Bearer <access_token>.

See Obtain access token.

Response

Sample response

{
    "code": 20000,
    "data": {
        "infra_action_state": "Succeeded"
    }
}

Response elements

Parameter	Example value	Type	Description
code	20000	Integer	The error code. If the error code returned is 20000, the request succeeded. If any other error code is returned, the request failed.
data	-	Object	The result of the API call. The data object may not be returned for some API actions. It returns the object of warehouse operation information.
data.infra_action_state	-	String	The state of the warehouse operation. Valid values: ONGOING SUCCEEDED FAILED CANCELED
data.err_msg	-	String	The reason that the warehouse operation failed. This field is only returned when infra_action_state is FAILED.
message	-	String	The error message. This element is returned only when the code returned is not 20000. NOTICE Do not conclude whether a request succeeded or failed based on the return value of message.