修改API

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

我的收藏

1. 接口描述

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

本接口(ModifyApi)用于修改 API 接口,可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyApi。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
ServiceId String API 所在的服务唯一 ID。
示例值:service-ody35h5e
ServiceType String API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
示例值:MOCK
RequestConfig RequestConfig 请求的前端配置。
ApiId String API 接口唯一 ID。
示例值:api-lqd35zzq
ApiName String 用户自定义的 API 名称。
示例值:xxx
ApiDesc String 用户自定义的 API 接口描述。
示例值:xxx
ApiType String API 类型,支持NORMAL和TSF,默认为NORMAL。
示例值:NORMAL
AuthType String API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
示例值:NONE
AuthRequired Boolean 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。
示例值:False
ServiceTimeout Integer API 的后端服务超时时间,单位是秒。
示例值:15
Protocol String API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
示例值:HTTP
EnableCORS Boolean 是否需要开启跨域,Ture 表示需要,False 表示不需要。
示例值:False
ConstantParameters.N Array of ConstantParameter 常量参数。
RequestParameters.N Array of ReqParameter 前端请求参数。
ApiBusinessType String 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。
示例值:NORMAL
ServiceMockReturnMessage String API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
示例值:test
MicroServices.N Array of MicroServiceReq API绑定微服务列表。
ServiceTsfLoadBalanceConf TsfLoadBalanceConfResp 微服务的负载均衡配置。
ServiceTsfHealthCheckConf HealthCheckConf 微服务的健康检查配置。
TargetServicesLoadBalanceConf Integer target类型负载均衡配置。(内测阶段)
示例值:0
TargetServicesHealthCheckConf HealthCheckConf target健康检查配置。(内测阶段)
ServiceScfFunctionName String scf 函数名称。当后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketRegisterFunctionName String scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketCleanupFunctionName String scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketTransportFunctionName String scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceScfFunctionNamespace String scf 函数命名空间。当后端类型是SCF时生效。
示例值:xxx
ServiceScfFunctionQualifier String scf函数版本。当后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketRegisterFunctionNamespace String scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketRegisterFunctionQualifier String scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketTransportFunctionNamespace String scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketTransportFunctionQualifier String scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketCleanupFunctionNamespace String scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceWebsocketCleanupFunctionQualifier String scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
示例值:xxx
ServiceScfIsIntegratedResponse Boolean 是否开启响应集成。当后端类型是SCF时生效。
示例值:False
IsDebugAfterCharge Boolean 开始调试后计费。(云市场预留字段)
示例值:False
TagSpecifications Tag 标签。
IsDeleteResponseErrorCodes Boolean 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
示例值:False
ResponseType String 返回类型。
示例值:html
ResponseSuccessExample String 自定义响应配置成功响应示例。
示例值:xxx
ResponseFailExample String 自定义响应配置失败响应示例。
示例值:xxx
ServiceConfig ServiceConfig API 的后端服务配置。
AuthRelationApiId String 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
示例值:api-xxx
ServiceParameters.N Array of ServiceParameter API的后端服务参数。
OauthConfig OauthConfig oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes.N Array of ResponseErrorCodeReq 用户自定义错误码配置。
IsBase64Encoded Boolean 是否开启Base64编码,只有后端为scf时才会生效。
示例值:False
IsBase64Trigger Boolean 是否开启Base64编码的header触发,只有后端为scf时才会生效。
示例值:False
Base64EncodedTriggerRules.N Array of Base64EncodedTriggerRule Header触发规则,总规则数不能超过10。
EventBusId String 事件总线ID。
示例值:eb-3sczdead
ServiceScfFunctionType String scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。
示例值:EVENT
ServiceScfEventIsAsyncCall Boolean 是否开启SCF Event异步调用。
示例值:false
EIAMAppType String EIAM应用类型。
示例值:Client
EIAMAuthType String EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。
示例值:Authorization
EIAMAppId String EIAM应用Token 有效时间,单位为秒,默认为7200秒。
TokenTimeout Integer EIAM应用ID。
示例值:7200

3. 输出参数

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

4. 示例

示例1 ModifyApi

可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效

输入示例

https://apigateway.tencentcloudapi.com/?Action=ModifyApi
&ServiceId=service-ody35h5e
&ApiId=api-lqd35zzq
&ApiName=http_api
&RequestConfig.Path=/
&RequestConfig.Method=ANY
&ServiceType=MOCK
&ServiceMockReturnMessage=test
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "6e00553a-8158-4f70-ad43-e1b046af1502"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ApiError api类错误。
FailedOperation.ApiInOperation 当前API正在操作中,请稍后再试。
FailedOperation.BackendDomainError 返回域名错误
FailedOperation.DomainNeedBeian 该域名还未在腾讯云备案,请备案之后再绑定域名。
FailedOperation.EIAMError EIAM返回错误。
FailedOperation.EbError 事件总线绑定/解绑失败。
FailedOperation.GetRoleError 获取角色失败,请确认完成API网关相关服务接口授权。
FailedOperation.ServiceError 服务相关的错误。
FailedOperation.ServiceInOperation 当前Service正在操作中, 请稍后再试。
InternalError.ApigwException API网关内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.ClbException CLB内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.OssException oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.ScfException SCF内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.TsfException TSF内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.VpcException vpc内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameter.BasicServiceNotAllowAttachPlugin 基础版服务不能绑定插件。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.IllegalProxyIp 非法的后端ip地址。
InvalidParameterValue.InvalidApiBusinessType 传入的Api业务类型必须为OAUTH。
InvalidParameterValue.InvalidBackendPath 后端服务路径配置错误。
InvalidParameterValue.InvalidClb 不合法的clb。
InvalidParameterValue.InvalidConstantParameters 不合法的常量参数。
InvalidParameterValue.InvalidIPAddress 参数后端地址取值错误。
InvalidParameterValue.InvalidMethod 方法错误。仅支持 ANY, BEGIN, GET, POST, DELETE, HEAD, PUT, OPTIONS, TRACE, PATCH,请修改后重新操作。
InvalidParameterValue.InvalidPort 后端服务端口错误。
InvalidParameterValue.InvalidPublicKey OAUTH2.0 API 公钥参数格式错误。
InvalidParameterValue.InvalidRegion 地域错误。
InvalidParameterValue.InvalidRequestParameters 不合法的请求参数。
InvalidParameterValue.InvalidScfConfig SCF类型API参数错误。
InvalidParameterValue.InvalidServiceConfig 不合法的服务配置。
InvalidParameterValue.InvalidServiceParam 参数配置错误,未配置在后端参数配置列表中。
InvalidParameterValue.InvalidServiceType 后端服务类型错误。WEBSOCKET类型的后端服务,前端协议需要配置为WEBSOCKET。
InvalidParameterValue.InvalidUpstream 当前后端通道不存在或者是无效状态。
InvalidParameterValue.InvalidUrl URL参数错误。
InvalidParameterValue.InvalidVpcConfig 无效vpc信息。
InvalidParameterValue.InvalidWSMethod 方法错误。WEBSOCKET类型的后端服务,前端方法需要配置为GET。
InvalidParameterValue.LengthExceeded 参数的长度超出限制。
InvalidParameterValue.LimitExceeded 参数个数超出限制,上限为100。
InvalidParameterValue.NotInOptions 参数取值错误。当前值不在可选范围内。
InvalidParameterValue.ParameterNotMatch 后端参数配置错误,未配置相关前端参数。
InvalidParameterValue.RangeExceeded 参数取值错误,不在参数范围内。
LimitExceeded.ApiCountLimitExceeded API数量超过限制。
ResourceNotFound.InvalidApi ApiId错误。
ResourceNotFound.InvalidOauthApi OAuth业务API错误。
ResourceNotFound.InvalidService 对应服务不可见。
UnsupportedOperation.InvalidAction 接口错误。
UnsupportedOperation.InvalidEndpointType 不支持后端类型。
UnsupportedOperation.ModifyEIAMAuthApi 不支持修改EIAM类型授权API。
UnsupportedOperation.ModifyProtocol 前端协议类型不支持修改。
UnsupportedOperation.ResourceAssociated 资源已关联,请先解除。
UnsupportedOperation.UnpackError Unpack函数错误