Get information for all subscribed nodes

  • Article
  • 2 minutes to read

Request

Method Request URI
GET https://restapi.cdn.azure.cn/subscriptions/{subscriptionId}/endpoints?apiVersion=1.0

URI parameter

Parameter name Description
subscriptionId Subscription unique identifier

Request header

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

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:

[
  {
    "EndpointID": "779bff4d-ef38-4fce-82d8-6b50cc4c183b",
    "Setting": {
      "CustomDomain": "www.example1.com",
      "Host": "www.example1.com",
      "ICP": "ICP123456",
      "Origin": {
        "Addresses": [
          "www.origin1.com"
        ]
      },
      "ServiceType": "Web"
    },
    "Status": {
      "Enabled": "true",
      "IcpVerifyStatus": "IcpVerified",
      "LifetimeStatus": "Normal",
      "CNameConfigured": "true",
      "FreeTrialExpired": "false",
      "TimeLastUpdated": "2017-04-28T07:34:54.849Z"
    }
  },
  {
    "EndpointID": "b4869250-3373-4650-bb7a-f6e809932c0e",
    "Setting": {
      "CustomDomain": "www.example2.com",
      "Host": "www.example2.com",
      "ICP": "ICP123456",
      "Origin": {
        "Addresses": [
          "www.origin2.com"
        ]
      },
      "ServiceType": "Web"
    },
    "Status": {
      "Enabled": "true",
      "IcpVerifyStatus": "IcpVerified",
      "LifetimeStatus": "Normal",
      "CNameConfigured": "true",
      "FreeTrialExpired": "false",
      "TimeLastUpdated": "2017-04-28T07:34:54.849Z"
    }
  }
]
Parameter name Description
EndpointID Node unique identifier
Enabled Task status
  • NotSet: State not set
  • Processing: Currently processing
  • Succeeded: Succeeded
  • Failed: Failed
IcpVerifyStatus ICP record verification information
  • IcpVerifying: Currently being verified
  • IcpVerifyFailed: Verification has failed
  • IcpVerified: Verification has succeeded
LifetimeStatus Node status
  • Normal: Normal
  • Creating: Creating
  • CreationFailed: Creation failed
  • Deleting: Deleting
  • Deleted: Deleted
  • Updating: Updating
  • Enabling: Activating
  • Disabling: Disabling
CNameConfigured Indicates whether the accelerated domain name CNAME record is already configured.
FreeTrialExpired Indicates whether the trial period has expired.
TimeLastUpdated Time of last update.

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