文档

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
  • 全部资源
    *

请求参数

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

指定的分组编号

927d50c0f2e54b359919923d908bb015
ApiIdstring

API 编号

8afff6c8c4c6447abb035812e4d66b65
ApiNamestring

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

ApiName
Descriptionstring

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

Api description
Visibilitystring

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

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

API 安全认证类型,目前可以取值:

  • APP:只允许已授权的 APP 调用
  • ANONYMOUS:允许匿名调用,设置为允许匿名调用需要注意:
    • 任何能够获取该 API 服务信息的人,都将能够调用该 API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该 API 请设置好按 API 的流量控制。
    • “ANONYMOUS”API不建议上架云市场,网关无法对调用者区分计量,也无法限制调用次数,若所在分组要上架云市场,建议将该 API 转移至其他分组,或将类型设置为“私有”,或选择“阿里云 APP”认证方式。
APP
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]"}
ResultTypestring

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

HTML
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"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-26API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)
文档反馈