节点管理-获取订阅下所有节点信息

请求

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

URI参数

</tr
参数名 描述
subscriptionId 订阅唯一标识

请求 Headers

请求包头 描述
x-azurecdn-request-date 必填。符合yyyy-MM-dd hh:mm:ss格式的UTC当前请求时间
Authorization 必填。授权头请参考CDN API签名机制

请求 Body

响应

响应由状态码,响应 headers以及响应 body组成。

状态码

状态码 描述
200 表明服务器成功返回
其他 表示出错的通用回复

响应 Headers

响应包头 描述
X-Correlation-Id 该请求唯一标识,用于追踪请求信息。

响应 Body

请求成功的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."
  }
}
参数名称 描述
Type 错误类型
  • CredentialInvalid:凭据不合法
  • ParameterMissing:缺少参数
  • ParameterInvalid:参数不合法
  • MissingAuthorizationHeader:缺少Authorization请求头
  • InvalidRequestDateHeader:请求时间不合法
  • MissingRequestDateHeader:缺少请求时间头
  • AuthorizationHeaderExpired:Authorization请求头已失效
  • InvalidAuthorizationHeader:Authorization请求头不合法
  • ApiKeyNotFound:API密钥不存在
  • InvalidApiKey:API密钥不合法
  • WrongSignature:签名不对
  • SubscriptionNotFound:订阅不存在
  • EndpointDoesNotBelongToSubscription:节点不属于订阅
  • EndpointNotInActiveState:节点不处于活跃状态
  • EndpointNotFound:节点不存在
  • MaliciousItemPathDetected:检查到恶意路径
  • PermissionDenied:权限不够
  • RequestThrottled:请求被限流

Message 错误信息