API 网关
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 网关 > API 文档 > 自定义域名相关接口 > 服务修改自定义域名

服务修改自定义域名

最近更新时间：2024-03-12 01:08:33

我的收藏

本页目录：

1. 接口描述

接口请求域名： apigateway.tencentcloudapi.com 。

本接口（ModifySubDomain）用于修改服务的自定义域名设置中的路径映射，可以修改绑定自定义域名之前的路径映射规则。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifySubDomain。
Version 是 String 公共参数，本接口取值：2018-08-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
ServiceId 是 String 服务唯一 ID。
示例值：service-19c5fnhy
SubDomain 是 String 待修改路径映射的自定义的域名。
示例值：xxxxxx
IsDefaultMapping 是 Boolean 是否修改为使用默认路径映射。为 true，表示使用默认路径映射，为 false，表示使用自定义路径映射。
示例值：false
CertificateId 否 String 证书 ID，协议包含 HTTPS 的时候要传该字段。
示例值：x x
Protocol 否 String 修改后的自定义域名协议类型。（http，https 或 http&https)
示例值：http
PathMappingSet.N 否 Array of PathMapping 修改后的路径映射列表。
NetType 否 String 网络类型 （'INNER' 或 'OUTER'）
示例值：OUTER
IsForcedHttps 否 Boolean 是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
示例值：x x

3. 输出参数

参数名称 类型 描述
Result Boolean 修改自定义域名操作是否成功。
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 服务修改自定义域名

服务修改自定义域名

输入示例

https://apigateway.tencentcloudapi.com/?Action=ModifySubDomain
&ServiceId=service-19c5fnhy
&SubDomain=doagkfrf.flyfly.wang
&CertificateId=''
&IsDefaultMapping=false
&Protocol=http
&NetType=OUTER
&PathMappingSet.0.Path=/
&PathMappingSet.0.Environment=release
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": true,
        "RequestId": "d7f6116b-8184-4bdd-8fbe-1ecbcfa1ea30"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.CertificateIdBindError 证书绑定错误。
FailedOperation.CertificateIdError 证书不存在或者您没有权限查看，请在ssl证书管理平台上传有效证书。
FailedOperation.PathMappingSetError 设置路径映射错误。
FailedOperation.ServiceError 服务相关的错误。
FailedOperation.ServiceInOperation 当前Service正在操作中, 请稍后再试。
FailedOperation.ServiceNotExist 服务不存在。
FailedOperation.SetCustomPathMappingError 自定义域名已使用默认路径映射，不支持设置自定义路径。
FailedOperation.SubDomainFormatError 自定义域名格式错误。
FailedOperation.UnknownProtocolTypeError 协议类型错误。
InternalError.OssException oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InvalidParameter.FormatError 参数格式错误。
ResourceNotFound.InvalidService 对应服务不可见。
UnsupportedOperation.ForceHttps 协议为HTTP时，不支持强制Https。
UnsupportedOperation.InvalidServiceTrade 当前服务处于隔离中，暂不支持此操作。
中国站