专享版-域名管理-华为云

API网关 APIG-修改域名:响应示例

响应示例状态码： 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" }

API网关 APIG 专享版-域名管理

API网关 APIG-修改域名:URI

URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号

API网关 APIG 专享版-域名管理

API网关 APIG-修改域名:响应参数

响应参数状态码： 201 表4 响应Body参数参数参数类型描述 url_domain String 自定义域名 id String 自定义域名的编号 status Integer CNAME解析状态 1: 未解析 2: 解析中 3: 解析成功 4: 解析失败 min_ssl_version String 支持的最小SSL版本 is_http_redirect_to_https Boolean 是否开启http到https的重定向，false为关闭，true为开启，默认为false verified_client_certificate_enabled Boolean 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 ingress_http_port Integer 访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。当创建域名时，该参数未填表示用默认80端口；如果填写该参数，则必须同时填写https_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。当修改域名时，该参数未填表示不修改该端口。 ingress_https_port Integer 访问该域名绑定的https协议入方向端口，-1表示无端口且协议不支持，可使用443默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTPS协议的自定义入方向端口。当创建域名时，该参数未填表示用默认443端口；如果填写该参数，则必须同时填写http_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。当修改域名时，该参数未填表示不修改该端口。状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

API网关 APIG 专享版-域名管理

API网关 APIG-修改域名:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 min_ssl_version 是 String 最小ssl协议版本号。支持TLSv1.1或TLSv1.2 is_http_redirect_to_https 否 Boolean 是否开启http到https的重定向，false为关闭，true为开启，默认为false verified_client_certificate_enabled 否 Boolean 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 ingress_http_port 否 Integer 访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。当创建域名时，该参数未填表示用默认80端口；如果填写该参数，则必须同时填写https_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。当修改域名时，该参数未填表示不修改该端口。 ingress_https_port 否 Integer 访问该域名绑定的https协议入方向端口，-1表示无端口且协议不支持，可使用443默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTPS协议的自定义入方向端口。当创建域名时，该参数未填表示用默认443端口；如果填写该参数，则必须同时填写http_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。当修改域名时，该参数未填表示不修改该端口。

API网关 APIG 专享版-域名管理

API网关 APIG-设置调试域名是否可以访问:URI

URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/sl-domain-access-settings 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号

API网关 APIG 专享版-域名管理

API网关 APIG-设置调试域名是否可以访问:响应参数

响应参数状态码： 400 表4 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表5 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

API网关 APIG 专享版-域名管理

API网关 APIG-设置调试域名是否可以访问:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 sl_domain_access_enabled 是 Boolean 设置调试域名是否可以访问，true为可以访问，false为禁止访问缺省值：true

API网关 APIG 专享版-域名管理

API网关 APIG-设置调试域名是否可以访问:响应示例

响应示例状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:sl_domain_access_enabled" } 状态码： 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" }

API网关 APIG 专享版-域名管理

云服务器内容精选

专享版-域名管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线