更新时间:2025-09-30 GMT+08:00
分享

修改独享域名接入进度

功能介绍

返回独享接入进度

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/premium-waf/host/{host_id}/access-progress

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

用户项目Id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

host_id

String

参数解释:

域名Id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

表3 请求Body参数

参数

是否必选

参数类型

描述

step

Integer

参数解释:

接入步骤(1:回源IP加白步骤,2:本地验证步骤 3:修改DNS解析步骤)

约束限制:

不涉及

取值范围:

1:回源IP加白步骤,2:本地验证步骤 3:修改DNS解析步骤

默认取值:

不涉及

status

Integer

参数解释:

完成情况(0:未完成,1:完成,2:跳过)

约束限制:

不涉及

取值范围:

0:未完成,1:完成,2:跳

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

step

Integer

参数解释:

接入步骤(1:回源IP加白步骤,2:本地验证步骤 3:修改DNS解析步骤)

约束限制:

不涉及

取值范围:

1:回源IP加白步骤,2:本地验证步骤 3:修改DNS解析步骤

默认取值:

不涉及

status

Integer

参数解释:

完成情况(0:未完成,1:完成,2:跳过)

约束限制:

不涉及

取值范围:

0:未完成,1:完成,2:跳

默认取值:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表6 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表8 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

{
  "step" : "1,",
  "status" : 0
}

响应示例

状态码:200

请求成功

{
  "step" : "1,",
  "status" : 0
}

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

相关文档