认证网站资产
功能介绍
认证租户的网站资产
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v3/{project_id}/webscan/domains/authenticate
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
用户的project_id，获取方法请参见获取项目ID。 最小长度：32 最大长度：32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：102400 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
domain_name |
是 |
String |
网站域名 最小长度：1 最大长度：256 |
auth_mode |
否 |
String |
认证方式:
缺省值：file 枚举值：
|
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
info_code |
String |
状态码:
枚举值：
|
info_description |
String |
返回的提示信息 最小长度：0 最大长度：64 |
usage_notice |
String |
网站域名认证使用须知 最小长度：0 最大长度：1000 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 最小长度：0 最大长度：50 |
error_msg |
String |
错误描述 最小长度：0 最大长度：256 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 最小长度：0 最大长度：50 |
error_msg |
String |
错误描述 最小长度：0 最大长度：256 |
状态码： 418
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 最小长度：0 最大长度：50 |
error_msg |
String |
错误描述 最小长度：0 最大长度：256 |
请求示例
POST https://{endpoint}/v3/{project_id}/webscan/domains/authenticate
{
"domain_name" : "https://127.0.0.1:8080",
"auth_mode" : "free"
}
响应示例
状态码： 200
OK
{
"info_code" : "success",
"info_description" : "Operation succeeded",
"usage_notice" : "使用须知： 1、您的账号已完成实名认证，且非受限账号。 2、您确认您已获得对扫描对象进行扫描的相关合法权利。 3、您确认您的扫描行为有合法合理目的，且符合适用的法律法规要求，不得利用本服务从事任何黑灰产等非法活动。 4、若您违反上述承诺，我们有权立即终止您对本服务的使用，并要求您对我们及相关第三方因此遭受的损失进行赔偿。"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
418 |
I'm a teapot |
错误码
请参见错误码。
