有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(ModifyService)用于修改服务的相关信息。当服务创建后,服务的名称、描述和服务类型均可被修改。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyService。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
ServiceId String 待修改服务的唯一 Id。
示例值:service-0c96l2bo
ServiceName String 修改后的服务名称。
示例值:test_https
ServiceDesc String 修改后的服务描述。
示例值:https
Protocol String 修改后的服务前端请求类型,如 http、https和 http&https。
示例值:https
NetTypes.N Array of String 网络类型列表,用于指定支持的访问类型,INNER为内网访问,OUTER为外网访问。默认为OUTER。
UniqVpcId String vpc属性,选择VPC后不可修改。为服务选择VPC后,可对接该VPC下的后端资源
示例值:vpc-adsada

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 用于修改服务

用于修改服务的相关信息。

输入示例

https://apigateway.tencentcloudapi.com/?Action=ModifyService
&ServiceId=service-0c96l2bo
&ServiceName=test_https
&ServiceDesc=https
&Protocol=https
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "e3705d00-bfe0-4fde-942c-cebd6b12431b"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ServiceError 服务相关的错误。
FailedOperation.ServiceInOperation 当前Service正在操作中, 请稍后再试。
InternalError.OssException oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.NotInOptions 参数取值错误。当前值不在可选范围内。
ResourceNotFound.InvalidService 对应服务不可见。
UnsupportedOperation.ModifyNetType 网络类型不支持修改。
UnsupportedOperation.ReduceNetTypes 不支持减少网络类型的操作。
UnsupportedOperation.UnpackError Unpack函数错误