ModifyApi
最近更新时间: 2025-10-20 17:05:59
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（ModifyApi）用于修改 API 接口，可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-08-02 19:47:05。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyApi |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ServiceId | 是 | 否 | String | API 所在的服务唯一 ID。 |
| ApiName | 否 | 否 | String | 用户自定义的 API 名称。 |
| ApiDesc | 否 | 否 | String | 用户自定义的 API 接口描述。 |
| ApiType | 否 | 否 | String | API 类型，支持NORMAL和TSF，默认为NORMAL。 |
| AuthType | 否 | 否 | String | API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。 |
| ServiceType | 是 | 否 | String | API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。 |
| AuthRequired | 否 | 否 | Bool | 是否需要签名认证，True 表示需要，False 表示不需要。待废弃。 |
| ServiceTimeout | 否 | 否 | Int64 | API 的后端服务超时时间，单位是秒。 |
| Protocol | 否 | 否 | String | API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。 |
| RequestConfig | 是 | 否 | RequestConfig | 请求的前端配置。 |
| EnableCORS | 否 | 否 | Bool | 是否需要开启跨域，Ture 表示需要，False 表示不需要。 |
| ConstantParameters | 否 | 否 | Array of ConstantParameter | 常量参数。 |
| RequestParameters | 否 | 否 | Array of ReqParameter | 前端请求参数。 |
| ApiBusinessType | 否 | 否 | String | 当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。 |
| ServiceMockReturnMessage | 否 | 否 | String | API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。 |
| MicroServices | 否 | 否 | Array of MicroServiceReq | API绑定微服务服务列表。 |
| ServiceTsfLoadBalanceConf | 否 | 否 | TsfLoadBalanceConfResp | 微服务的负载均衡配置。 |
| ServiceTsfHealthCheckConf | 否 | 否 | HealthCheckConf | 微服务的健康检查配置。 |
| TargetServicesLoadBalanceConf | 否 | 否 | Int64 | target类型负载均衡配置。（内测阶段） |
| TargetServicesHealthCheckConf | 否 | 否 | HealthCheckConf | target健康检查配置。（内测阶段） |
| ServiceScfFunctionName | 否 | 否 | String | scf 函数名称。当后端类型是SCF时生效。 |
| ServiceWebsocketRegisterFunctionName | 否 | 否 | String | scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceWebsocketCleanupFunctionName | 否 | 否 | String | scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceWebsocketTransportFunctionName | 否 | 否 | String | scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceScfFunctionNamespace | 否 | 否 | String | scf 函数命名空间。当后端类型是SCF时生效。 |
| ServiceScfFunctionQualifier | 否 | 否 | String | scf函数版本。当后端类型是SCF时生效。 |
| ServiceWebsocketRegisterFunctionNamespace | 否 | 否 | String | scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceWebsocketRegisterFunctionQualifier | 否 | 否 | String | scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceWebsocketTransportFunctionNamespace | 否 | 否 | String | scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceWebsocketTransportFunctionQualifier | 否 | 否 | String | scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceWebsocketCleanupFunctionNamespace | 否 | 否 | String | scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceWebsocketCleanupFunctionQualifier | 否 | 否 | String | scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 |
| ServiceScfIsIntegratedResponse | 否 | 否 | Bool | 是否开启响应集成。当后端类型是SCF时生效。 |
| IsDebugAfterCharge | 否 | 否 | Bool | 开始调试后计费。（云市场预留字段） |
| TagSpecifications | 否 | 否 | Tag | 标签。 |
| IsDeleteResponseErrorCodes | 否 | 否 | Bool | 是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。 |
| ResponseType | 否 | 否 | String | 返回类型。 |
| ResponseSuccessExample | 否 | 否 | String | 自定义响应配置成功响应示例。 |
| ResponseFailExample | 否 | 否 | String | 自定义响应配置失败响应示例。 |
| ServiceConfig | 否 | 否 | ServiceConfig | API 的后端服务配置。 |
| AuthRelationApiId | 否 | 否 | String | 关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。 |
| ServiceParameters | 否 | 否 | Array of ServiceParameter | API的后端服务参数。 |
| OauthConfig | 否 | 否 | OauthConfig | oauth配置。当AuthType是OAUTH时生效。 |
| ApiId | 是 | 否 | String | API 接口唯一 ID。 |
| ResponseErrorCodes | 否 | 否 | Array of ResponseErrorCodeReq | 用户自定义错误码配置。 |
| IsBase64Encoded | 否 | 否 | Bool | 是否开启Base64编码，只有后端为scf时才会生效。 |
| IsBase64Trigger | 否 | 否 | Bool | 是否开启Base64编码的header触发，只有后端为scf时才会生效。 |
| Base64EncodedTriggerRules | 否 | 否 | Array of Base64EncodedTriggerRule | Header触发规则，总规则数不能超过10。 |
| EventBusId | 否 | 否 | String | 此参数对外不可见。 事件总线ID。 |
| InternalReqSource | 否 | 否 | String | 此参数对外不可见。 内部参数，标识请求来源 |
| ServiceScfFunctionType | 否 | 否 | String | 此参数对外不可见。 scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。 |
| EIAMAppType | 否 | 否 | String | 此参数对外不可见。 EIAM应用类型。 |
| EIAMAuthType | 否 | 否 | String | 此参数对外不可见。 EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。 |
| EIAMAppId | 否 | 否 | String | 此参数对外不可见。 EIAM应用Token 有效时间，单位为秒，默认为7200秒。 |
| TokenTimeout | 否 | 否 | Int64 | 此参数对外不可见。 EIAM应用ID。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| ResourceNotFound.InvalidApi | ApiId错误。 |
| InvalidParameterValue.InvalidApiBusinessType | 传入的Api业务类型必须为OAUTH。 |
| FailedOperation.ServiceError | 服务相关的错误。 |
| FailedOperation.ApiError | api类错误。 |
| InternalError.OssException | oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InvalidParameterValue.InvalidConstantParameters | 不合法的常量参数。 |
| LimitExceeded.ApiCountLimitExceeded | API数量超过限制。 |
| InvalidParameterValue.InvalidClb | 不合法的clb。 |
| InvalidParameterValue.InvalidRequestParameters | 不合法的请求参数。 |
| InvalidParameterValue.InvalidServiceConfig | 不合法的服务配置。 |
| InternalError.VpcException | vpc内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InvalidParameterValue.InvalidPublicKey | OAUTH2.0 API 公钥参数格式错误。 |
| FailedOperation.ApiInOperation | 当前API正在操作中，请稍后再试。 |
| InvalidParameterValue.InvalidIPAddress | 参数后端地址取值错误。 |
| InvalidParameterValue.LengthExceeded | 参数的长度超出限制。 |
| InvalidParameterValue.InvalidServiceParam | 参数配置错误，未配置在后端参数配置列表中。 |
| InvalidParameterValue.RangeExceeded | 参数取值错误，不在参数范围内。 |
| InvalidParameterValue.InvalidBackendPath | 后端服务路径配置错误。 |
| InvalidParameterValue.InvalidServiceType | 后端服务类型错误。WEBSOCKET类型的后端服务，前端协议需要配置为WEBSOCKET。 |
| InvalidParameterValue.InvalidWSMethod | 方法错误。WEBSOCKET类型的后端服务，前端方法需要配置为GET。 |
| InvalidParameterValue.InvalidPort | 后端服务端口错误。 |
| UnsupportedOperation.ModifyProtocol | 前端协议类型不支持修改。 |
| InvalidParameterValue.ParameterNotMatch | 后端参数配置错误，未配置相关前端参数。 |
| InvalidParameterValue.NotInOptions | 参数取值错误。当前值不在可选范围内。 |
| InvalidParameterValue.InvalidRegion | 地域错误。 |
| InternalError.ApigwException | API网关内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.TsfException | TSF内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InvalidParameterValue.InvalidScfConfig | SCF类型API参数错误。 |
| InvalidParameterValue.InvalidUrl | URL参数错误。 |
| InvalidParameterValue.LimitExceeded | 参数个数超出限制，上限为100。 |
| ResourceNotFound.InvalidOauthApi | OAuth业务API错误。 |
| UnsupportedOperation.InvalidAction | 接口错误。 |
| InvalidParameterValue.InvalidMethod | 方法错误。仅支持 ANY, BEGIN, GET, POST, DELETE, HEAD, PUT, OPTIONS, TRACE, PATCH，请修改后重新操作。 |
| FailedOperation.GetRoleError | 获取角色失败，请确认完成API网关相关服务接口授权。 |
| InternalError.ScfException | SCF内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| UnsupportedOperation.ResourceAssociated | 资源已关联，请先解除。 |
| FailedOperation.EbError | 事件总线绑定/解绑失败。 |
| UnsupportedOperation.InvalidEndpointType | 不支持后端类型。 |
| UnsupportedOperation.ModifyEIAMAuthApi | 不支持修改EIAM类型授权API。 |
| FailedOperation.ServiceInOperation | 当前Service正在操作中, 请稍后再试。 |