API网关 APIGAPI网关 APIG

更新时间:2021/06/18 GMT+08:00
分享

修改域名

功能介绍

修改绑定的域名所对应的配置信息。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目编号

instance_id

String

实例编号

group_id

String

分组的编号

domain_id

String

域名的编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

min_ssl_version

String

最小ssl协议版本号。支持TLSv1.1或TLSv1.2

缺省值:TLSv1.1

枚举值:

  • TLSv1.1

  • TLSv1.2

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

url_domain

String

自定义域名

id

String

自定义域名的编号

status

Integer

CNAME解析状态

  • 1: 未解析

  • 2: 解析中

  • 3: 解析成功

  • 4: 解析失败

枚举值:

  • 1

  • 2

  • 3

  • 4

min_ssl_version

String

支持的最小SSL版本

状态码: 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

错误描述

请求示例

{
  "min_ssl_version" : "TLSv1.2"
}

响应示例

状态码: 200

No Content

{
  "id" : "0a515af69f4e4dcca84fbf85f68c0e27",
  "url_domain" : "www.example.com",
  "status" : 3,
  "min_ssl_version" : "TLSv1.2"
}

状态码: 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"
}

状态码

状态码

描述

200

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品