修改域名
功能介绍
修改绑定的域名所对应的配置信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/apic/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
instance_id |
是 |
String |
实例ID |
group_id |
是 |
String |
分组的编号 |
domain_id |
是 |
String |
域名的编号 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
min_ssl_version |
是 |
String |
最小ssl协议版本号。支持TLSv1.1或TLSv1.2 缺省值:TLSv1.1 |
is_http_redirect_to_https |
否 |
Boolean |
是否开启http到https的重定向,false为关闭,true为开启,默认为false 缺省值:false |
verified_client_certificate_enabled |
否 |
Boolean |
是否开启客户端证书校验。只有绑定证书时,该参数才生效。当绑定证书存在trusted_root_ca时,默认开启;当绑定证书不存在trusted_root_ca时,默认关闭。 缺省值:false |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
url_domain |
String |
自定义域名 |
id |
String |
自定义域名的编号 |
status |
Integer |
CNAME解析状态
|
min_ssl_version |
String |
支持的最小SSL版本 |
is_http_redirect_to_https |
Boolean |
是否开启http到https的重定向,false为关闭,true为开启,默认为false 缺省值:false |
verified_client_certificate_enabled |
Boolean |
是否开启客户端证书校验。只有绑定证书时,该参数才生效。当绑定证书存在trusted_root_ca时,默认开启;当绑定证书不存在trusted_root_ca时,默认关闭。 缺省值:false |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
修改绑定的域名配置,最小SSL协议版本修改为TLSv1.2
{ "min_ssl_version" : "TLSv1.2" }
响应示例
状态码: 201
Created
{ "id" : "0a515af69f4e4dcca84fbf85f68c0e27", "url_domain" : "www.example.com", "status" : 3, "min_ssl_version" : "TLSv1.2", "is_http_redirect_to_https" : false, "verified_client_certificate_enabled" : false }
状态码: 400
Bad Request
{ "error_code" : "APIG.3474", "error_msg" : "The API group ID in the URL does not match the API group to which the URL domain has been bound" }
状态码: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
状态码: 403
Forbidden
{ "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" }
状态码: 404
Not Found
{ "error_code" : "APIG.3020", "error_msg" : "The URL domain does not exist" }
状态码: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
状态码
状态码 |
描述 |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。