
# 获取网站配置
#### 功能介绍
获取网站登录配置
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsInspector/doc?api=ShowDomainSettings)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### URI
GET /v3/{project_id}/webscan/domains/settings
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                  |
|:---|:---|:---|:---|
| project_id | 是    | String | 用户的project_id，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-vss/vss_api_04_019.html)。 最小长度：**32** 最大长度：**32** |
表2Query参数 
| 参数        | 是否必选 | 参数类型   | 描述                             |
|:---|:---|:---|:---|
| domain_id | 是    | String | 网站域名ID 最小长度：**32** 最大长度：**32** |
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                  |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：**1** 最大长度：**102400** |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数             | 参数类型                 | 描述                                                                                                            |
|:---|:---|:---|
| domain_id      | String               | 网站域名ID 最小长度：**32** 最大长度：**32**                                                                                |
| login_url      | String               | 网站需要登录时，设置登录页面 最小长度：**0** 最大长度：**2048**                                                                       |
| login_username | String               | 网站需要登录时，设置登录用户名 最小长度：**0** 最大长度：**256**                                                                       |
| login_password | String               | 当网站需要登录时，设置登录密码；当获取网站配置时，若返回值为"\*\*\*"，表示用户已设置登录密码，若返回值为null表示用户未设置登录密码 最小长度：**0** 最大长度：**50**                |
| login_cookies  | String               | 当网站需要登录时，设置登录cookie；获取网站配置时，如果返回值是"\*\*\*"，表示用户已设置登录cookie，若返回值为null表示用户未设置登录cookie 最小长度：**0** 最大长度：**21845** |
| verify_url     | String               | 设置用于验证登录是否成功的网址 最小长度：**0** 最大长度：**2048**                                                                      |
| http_headers   | Map\<String,String\> | 设置自定义HTTP请求头；获取网站配置时，如果key对应value值是"\*\*\*"，表示用户已设置此key对应的内容，如果key对应的value值为null表示用户未设置value值                 |
| domain_name    | String               | 网站域名 最小长度：**1** 最大长度：**256**                                                                                  |
   
**状态码： 400**
表5响应Body参数 
| 参数         | 参数类型   | 描述                           |
|:---|:---|:---|
| error_code | String | 错误码 最小长度：**0** 最大长度：**50**   |
| error_msg  | String | 错误描述 最小长度：**0** 最大长度：**256** |
   
**状态码： 401**
表6响应Body参数 
| 参数         | 参数类型   | 描述                           |
|:---|:---|:---|
| error_code | String | 错误码 最小长度：**0** 最大长度：**50**   |
| error_msg  | String | 错误描述 最小长度：**0** 最大长度：**256** |
   
**状态码： 418**
表7响应Body参数 
| 参数         | 参数类型   | 描述                           |
|:---|:---|:---|
| error_code | String | 错误码 最小长度：**0** 最大长度：**50**   |
| error_msg  | String | 错误描述 最小长度：**0** 最大长度：**256** |
   
#### 请求示例
```
GET https://{endpoint}/v3/{project_id}/webscan/domains/settings?domain_id=2ec0993b8572455aacf14b6f9288b167
```
#### 响应示例
**状态码： 200**
OK
```
{
  "domain_id" : "2ec0993b8572455aacf14b6f9288b167",
  "domain_name" : "127.0.0.1:8080",
  "login_url" : "https://127.0.0.1:8080/login",
  "login_username" : null,
  "login_password" : null,
  "login_cookies" : null,
  "verify_url" : null,
  "http_headers" : null
}
```
#### 状态码
| 状态码 | 描述           |
|:---|:---|
| 200 | OK           |
| 400 | Bad Request  |
| 401 | Unauthorized |
| 418 | I'm a teapot |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-vss/ErrorCode.html)。
