- Article
-
-
You can use the API to view the status and results for asynchronous operations.
Request
| Method
| Request URI
|
|---|
| GET |
https://restapi.cdn.azure.cn/subscriptions/{subscriptionId}/endpoints/{endpointId}/operations/{operationId}?apiVersion=1.0 |
URI parameter
| Parameter name
| Description
|
|---|
| subscriptionId |
Subscription unique identifier |
| endpointId |
Target node unique identifier |
| operationId |
Operation unique identifier |
| Request header |
Description |
| x-azurecdn-request-date |
Required. Enter the current UTC request time in yyyy-MM-dd hh:mm:ss format. |
| Authorization |
Required. Refer to CDN API signing mechanism for authorization headers. |
Request body
None
Response
A response comprises a status code, response headers, and a response body.
Status code
| Status code
| Description
|
|---|
| 200 |
Indicates that the server has returned a response successfully. |
| Other |
General response indicating that an error has occurred. |
| Response header
|
Description
|
|---|
| X-Correlation-Id |
The request's unique identifier, which is used to track request information. |
Response body
JSON example for request succeeded:
{
"Id": "a97459bf-e4c4-4d4f-94e4-b775f0f09f31",
"Type": "Purge",
"Status": "Succeeded",
"Message": null,
"Start": "2017-05-02T06:34:07.869Z",
"End": "2017-05-02T06:44:07.869Z",
"EndpointId": "46fecf3c-e874-49aa-891d-0d4dc93213e0",
"SubscriptionId": "5dd0413d-a2f9-442a-b836-128d87753fa9"
}
| Parameter name
| Description
|
|---|
| Type |
Operation type |
| Message |
Operation information |
| Status |
Task status
- NotSet: State not set
- Processing: Currently processing
- Succeeded: Succeeded
- Failed: Failed
|
| Start |
Start time |
| End |
End time |
| EndpointId |
Node unique identifier |
| SubscriptionId |
Subscription unique identifier |
JSON example for request failed:
{
"Succeeded": false,
"ErrorInfo": {
"Type": "MissingAuthorizationHeader",
"Message": "Missing authorization header."
}
}
| Parameter name
| Description
|
|---|
| Type |
Error type
- CredentialInvalid: Invalid credentials
- ParameterMissing: Parameter missing
- ParameterInvalid: Invalid parameter
- MissingAuthorizationHeader: Authorization header missing
- InvalidRequestDateHeader: Invalid request date header
- MissingRequestDateHeader: Missing request date header
- AuthorizationHeaderExpired: Authorization header expired
- InvalidAuthorizationHeader: Invalid authorization header
- ApiKeyNotFound: API key not found
- InvalidApiKey: Invalid API key
- WrongSignature: Wrong signature
- SubscriptionNotFound: Subscription does not exist
- EndpointDoesNotBelongToSubscription: Endpoint does not belong to subscription
- EndpointNotInActiveState: Endpoint not in active state
- EndpointNotFound: Endpoint does not exist
- MaliciousItemPathDetected: Malicious item path detected
- PermissionDenied: Insufficient permissions
- RequestThrottled: Request throttled
|
| Message |
Error information |