ModifyApi - 修改API定义

修改API的定义信息。

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:ModifyApiWrite
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
GroupIdstring

指定的分组编号

927d50c0f2e54b359919923d908bb015
ApiIdstring

API编号

8afff6c8c4c6447abb035812e4d66b65
ApiNamestring

API的名称,组内不允许重复。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,4~50个字符

ApiName
Descriptionstring

API描述信息,最多180个字符

Api description
Visibilitystring

API是否公开,目前可以取值:

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

Consumer向网关发送API请求的相关配置项

{"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}
ServiceConfigstring

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

{"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}
RequestParametersstring

Consumer向网关发送API请求的参数描述

[{"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"}]
SystemParametersstring

系统参数

[{\"ParameterName\": \"CaAppId\", \"Location\": \"HEAD\", \"ServiceParameterName\": \"x-ca-appid\"}]
ConstantParametersstring

常量参数

[{\"ServiceParameterName\":\"HOST\",\"ConstantValue\":\"uat-cgi.smarket.net.cn\",\"Location\":\"HEAD\",\"Description\":\"\\u540e\\u7aefVPC-HOST\"}]
ServiceParametersstring

网关向后端服务发送API请求的参数描述

[{"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"}]
ServiceParametersMapstring

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

[{"ServiceParameterName":"age","RequestParameterName":"age"},{"ServiceParameterName":"sex","RequestParameterName":"sex"},{"ServiceParameterName":"userId","RequestParameterName":"userId"},{"ServiceParameterName":"clientIp","RequestParameterName":"CaClientIp"},{"ServiceParameterName":"constance","RequestParameterName":"constance"}]
ResultTypestring

后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。 该值仅用于生成文档使用。不对返回结果产生影响。

HTML
ResultSamplestring

后端服务返回应答的示例

200
FailResultSamplestring

后端服务失败返回应答的示例

{"errorCode":"fail","errorMessage":"param invalid"}
ErrorCodeSamplesstring

后端服务返回的错误码示例

[{"Code":"400","Message":"Missing the userId","Description":"param invalid"}]
ResultDescriptionsstring

api的返回说明

[]
OpenIdConnectConfigstring

第三方账号认证OpenID Connect相关配置项

{\"OpenIdApiType\":\"IDTOKEN\",\"PublicKey\":\"lzlj1573\",\"IdTokenParamName\":\"\",\"PublicKeyId\":\"lzljorders\"}
AllowSignatureMethodstring

API的客户端请求签名方法,可选值:

  • HmacSHA256
  • HmacSHA1,HmacSHA256
HmacSHA256
WebSocketApiTypestring

双向通信API类型:

  • COMMON:普通API
  • REGISTER:注册API
  • UNREGISTER:注销API
  • NOTIFY:下行通知
COMMON
ResultBodyModelstring

api的返回结果

{}
ForceNonceCheckboolean
  • 设置ForceNonceChecktrue, 请求时强制检查X-Ca-Nonce,这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。
  • 设置ForceNonceCheckfalse, 则不检查。修改时,不设置则不修改原来的取值。
true
DisableInternetboolean
  • 设置DisableInternet为true,仅支持内网调用API。
  • 设置DisableInternet为false,则不限制调用。
说明修改API时,不设置则不修改原来的取值。
true
AppCodeAuthTypestring

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

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

后端服务ID

0d105f80a8f340408bd34954d4e4ff22
BackendEnableboolean

是否启用后端服务

true

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

6C87A26A-6A18-4B8E-8099-705278381A2C

示例

正常返回示例

JSON格式

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

XML格式

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

错误码

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

阿里云首页 API 网关 相关技术圈