Get CDN Operation Status

 

Updated: October 20, 2011

The Get CDN Operation Status operation returns the status of the specified CDN operation. After calling an asynchronous CDN operation, you can call Get CDN Operation Status to determine whether the operation has succeeded, failed, or is still in progress.

The Get CDN Operation Status request may be specified as follows. Replace <subscription-id> with your subscription ID, and <request-id> with the request ID for the request you wish to track. The request ID is returned in the x-ms-request-id response header for every request.

Method

Request URI

HTTP Version

GET

https://management.core.windows.net/<subscription-id>/services/cdn/operations/<request-id>

HTTP/1.1

The following table describes required and optional request headers.

Request Header

Description

Content-Type

Required. Set this header to application/xml.

x-ms-version

Required. Specifies the version of the operation to use for this request. This header should be set to 2011-06-30 or later. For more information about versioning headers, see Service Management Versioning.

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 200 (OK).

For information about status codes, see Service Management Status and Error Codes.

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get CDN Operation Status operation itself.

If the asynchronous operation succeeded, the response body includes the HTTP status code 200 (OK) for the successful request.

If the asynchronous operation failed, the response body includes the HTTP status code for the failed request, and also includes error information regarding the failure.

Copy 

<?xml version="1.0" encoding="utf-8"?>
<CdnOperation xmlns="http://schemas.microsoft.com/windowsazure">
  <Id>request-id</Id>
  <Name>operation-name</Name>
  <SubscriberId>subscription-id</SubscriberId>
  <Status>request-status</Status>
  <!-- Response includes HttpStatusCode only if the operation succeeded or failed -->
  <HttpStatusCode>http-status-code-for-asynchronous-operation</HttpStatusCode>
  <!-- Response includes additional error information only if the operation failed -->
  <CdnErrorCode>error-code</CdnErrorCode>
  <Message>error-message</Message>
</CdnOperation>

The following table describes the key elements in the response body:

Element name

Description

Id

The request ID of the asynchronous request. This value is returned in the x-ms-request-id response header of the asynchronous request.

Name

The operation name of the asynchronous request. This name is associated internally with the CDN REST API call made with the corresponding request ID. Possible values include CreateCdnEndpoint, DeleteCdnEndpoint, GetCdnEndpoint, GetCdnEndpointConfiguration, UpdateCdnEndpointConfiguration, ListCdnEndpoints, CreateCName, UpdateCName, and DeleteCName.

SubscriberId

The asynchronous request caller’s subscription ID.

Status

The status of the asynchronous request. Possible values include InProgress, Succeeded, or Failed.

HttpStatusCode

Optional. The HTTP status code for the asynchronous request. This value is only set for operations that have completed.

CdnErrorCode

The management service error code returned if the asynchronous request failed. See Service Management Status and Error Codes for information about possible error codes returned by the service.

Message

The error message returned if the asynchronous request failed.

Any management certificate associated with the subscription specified by <subscription-id> can be used to authenticate this operation. For additional details, see Authenticating Service Management Requests.

The Get CDN Operation Status operation must be polled to determine when an asynchronous CDN Endpoint operation has completed. The following CDN Endpoint operations are asynchronous: Create CDN Endpoint, Update CDN Endpoint Configuration, Delete CDN Endpoint, Create CDN Endpoint CName, Update CDN Endpoint CName, Delete CDN Endpoint CName. While the asynchronous operations are in progress, a call to Get CDN Operation Status will return InProgress as the value of Status. A list of all asynchronous operations that are in progress can be obtained with the List Pending CDN Operations operation. Status will have a value of Succeeded and the HttpStatusCode value will be 200 (OK) for asynchronous operations that have completed successfully. Asynchronous operations that fail will have a Status value of Failed and an HttpStatusCode, CdnErrorCode, and Message value with information about the failure.

Show: