获取所有订阅节点的信息

请求

方法 请求 URI
GET https://restapi.cdn.azure.cn/subscriptions/{subscriptionId}/endpoints?apiVersion=1.0

URI 参数

参数名称 描述
subscriptionId 订阅唯一标识符

请求头

请求标头 说明
x-azurecdn-request-date 必需。 以 yyyy-MM-dd hh:mm:ss 格式输入当前 UTC 请求时间。
授权 必需。 有关授权标头,请参阅 CDN API 签名机制

请求正文

响应

响应包括状态代码、响应头和响应正文。

状态代码

状态代码 描述
200 指示服务器已成功返回响应。
其他 指示发生错误的一般响应。

响应标头

响应头 描述
X-Correlation-Id 请求的唯一标识符,用于跟踪请求信息。

响应正文

请求成功的 JSON 示例

[
  {
    "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"
    }
  }
]
参数名称 描述
EndpointID 节点唯一标识符
Enabled 任务状态
  • NotSet:状态未知
  • Processing:正在处理
  • Succeeded:成功
  • Failed:失败
IcpVerifyStatus ICP 备案验证信息
  • IcpVerifying:当前正在验证
  • IcpVerifyFailed:验证失败
  • IcpVerified:验证成功
LifetimeStatus 节点状态
  • Normal:正常
  • Creating:正在创建
  • CreationFailed:创建失败
  • Deleting:正在删除
  • Deleted:已删除
  • Updating:正在更新
  • Enabling:正在激活
  • Disabling:正在禁用
CNameConfigured 指示是否已配置加速域名 CNAME 记录。
FreeTrialExpired 指示试用期是否已过。
TimeLastUpdated 上次更新时间。

请求失败的 JSON 示例

{
  "Succeeded": false,
  "ErrorInfo": {
    "Type": "MissingAuthorizationHeader",
    "Message": "Missing authorization header."
  }
}
参数名称 描述
类型 错误类型
  • CredentialInvalid:凭据无效
  • ParameterMissing:参数缺失
  • ParameterInvalid:参数无效
  • MissingAuthorizationHeader:授权标头缺失
  • InvalidRequestDateHeader:请求日期标头无效
  • MissingRequestDateHeader:请求日期标头缺失
  • AuthorizationHeaderExpired:授权标头过期
  • InvalidAuthorizationHeader:授权标头无效
  • ApiKeyNotFound:找不到 API 密钥
  • InvalidApiKey:API 密钥无效
  • WrongSignature:签名错误
  • SubscriptionNotFound:订阅不存在
  • EndpointDoesNotBelongToSubscription:终结点不属于订阅
  • EndpointNotInActiveState:终结点未处于活跃状态
  • EndpointNotFound:终结点不存在
  • MaliciousItemPathDetected:检测到恶意项路径
  • PermissionDenied:权限不足
  • RequestThrottled:请求中止

消息 错误信息