调用ModifyApi修改API定义。

" 此接口面向开放API的用户

  • 该接口需要全量更新，不支持部分参数更新
  • 修改ApiName时需要注意，同一个分组内API不允许重名
  • 修改RequestPath时需要注意，同一个分组内Path不允许重复
  • 该接口调用的QPS限制为：单用户QPS不超过50

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 否 ModifyApi

操作接口名，系统规定参数，取值：ModifyApi。

ApiId String 是 8afff6c8c4c6447abb035812e4d66b65

API编号
ApiName String 是 ApiName

API的名称，组内不允许重复。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50个字符
RequestConfig String 是 {"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}

Consumer向网关发送API请求的相关配置项
ServiceConfig String 是 {"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}

网关向后端服务发送API请求的相关配置项
Visibility String 是 PUBLIC

API是否公开，目前可以取值：

  • PUBLIC：公开，如选择此类型，该API的线上环境，会在所有用户的控制台“发现API”页面展示
  • PRIVATE：不公开，如选择此类型，当该组API在云市场上架时，私有类型的API不会上架
GroupId String 否 927d50c0f2e54b359919923d908bb015

指定的分组编号
Description String 否 Api description

API描述信息，最多180个字符
AuthType String 否 APP

API安全认证类型，目前可以取值：

  • APP：只允许已授权的APP调用
  • ANONYMOUS：允许匿名调用，设置为允许匿名调用需要注意：
    • 任何能够获取该API服务信息的人，都将能够调用该API。网关不会对调用者做身份认证，也无法设置按用户的流量控制，若开放该API请设置好按API的流量控制。
    • “ANONYMOUS”API不建议上架云市场，网关无法对调用者区分计量，也无法限制调用次数，若所在分组要上架云市场，建议将该API转移至其他分组，或将类型设置为“私有”，或选择“阿里云APP”认证方式。
RequestParameters String 否 [{"ParameterType":"Number","Required":"OPTIONAL","isHide":false,"ApiParameterName":"age","DefaultValue":"20","DemoValue":"20","Description":"年龄","MinValue":18,"MaxValue":100,"Location":"Head"},{"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"sex","DefaultValue":"boy","DemoValue":"boy","Description":"性别","EnumValue":"boy,girl","Location":"Query"},{"ParameterType":"Number","Required":"REQUIRED","isHide":false,"ApiParameterName":"userId","MaxLength":10,"MinValue":10000000,"MaxValue":100000000,"Location":"Path"},{"ApiParameterName":"CaClientIp","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","Description":"客户端IP"},{"ApiParameterName":"constance","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","DefaultValue":"constance","Description":"constance"}]

Consumer向网关发送API请求的参数描述
ServiceParameters String 否 [{"ServiceParameterName":"age","Location":"Head","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"sex","Location":"Query","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"userId","Location":"Path","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"clientIp","Location":"Head","Type":"String","ParameterCatalog":"SYSTEM"},{"ServiceParameterName":"constance","Location":"Head","Type":"String","ParameterCatalog":"CONSTANT"}]

网关向后端服务发送API请求的参数描述
ServiceParametersMap String 否 [{"ServiceParameterName":"age","RequestParameterName":"age"},{"ServiceParameterName":"sex","RequestParameterName":"sex"},{"ServiceParameterName":"userId","RequestParameterName":"userId"},{"ServiceParameterName":"clientIp","RequestParameterName":"CaClientIp"},{"ServiceParameterName":"constance","RequestParameterName":"constance"}]

Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系
ResultType String 否 HTML

后端服务返回应答的格式，目前可以设置为：JSON、TEXT、BINARY、XML、HTML。

该值仅用于生成文档使用。不对返回结果产生影响。
ResultSample String 否 200

后端服务返回应答的示例
FailResultSample String 否 {"errorCode":"fail","errorMessage":"param invalid"}

后端服务失败返回应答的示例
ErrorCodeSamples String 否 [{"Code":"400","Message":"Missing the userId","Description":"param invalid"}]

后端服务返回的错误码示例
AllowSignatureMethod String 否 HmacSHA256

API的客户端请求签名方法，可选值：

  • HmacSHA256
  • HmacSHA1,HmacSHA256
WebSocketApiType String 否 COMMON

双向通信API类型：

  • COMMON:普通API
  • REGISTER:注册API
  • UNREGISTER:注销API
  • NOTIFY:下行通知
ForceNonceCheck Boolean 否 true
  • 设置ForceNonceCheck为true, 请求时强制检查X-Ca-Nonce，这个是请求的唯一标识，一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性，同样的值，15分内只能被使用一次。可以有效防止API的重放攻击。
  • 设置ForceNonceCheck为false, 则不检查。修改时，不设置则不修改原来的取值。
DisableInternet Boolean 否 true
  • 设置DisableInternet为true, 仅支持内网调用API。
  • 设置DisableInternet为false, 则不限制调用。
说明 修改API时，不设置则不修改原来的取值。
AppCodeAuthType String 否 DEFAULT

支持AppCode的认证类型。可选值：

  • DEFAULT：默认值：上架云市场后支持
  • DISABLE： 不支持AppCode调用方式
  • HEADER ：仅在Header中支持
  • HEADER_QUERY ：可以在Header或者Query中支持

返回数据

名称 类型 示例值 描述
RequestId String 6C87A26A-6A18-4B8E-8099-705278381A2C

请求ID

示例

请求示例

http(s)://apigateway.cn-hangzhou.aliyuncs.com/?Action=ModifyApi
&ApiId=8afff6c8c4c6447abb035812e4d66b65
&ApiName=ApiName
&RequestConfig={"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}
&ServiceConfig={"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}
&Visibility=PUBLIC
&<公共请求参数>

正常返回示例

XML格式 

<ModifyApiResponse>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</ModifyApiResponse>

JSON格式 

{
    "RequestId":"6C87A26A-6A18-4B8E-8099-705278381A2C"
}

错误码

访问错误中心查看更多错误码。