修改API的定义信息。
接口说明
" 此接口面向开放 API 的用户
- 该接口需要全量更新,不支持部分参数更新
- 修改 ApiName 时需要注意,同一个分组内 API 不允许重名
- 修改 RequestPath 时需要注意,同一个分组内 Path 不允许重复
- 该接口调用的 QPS 限制为:单用户 QPS 不超过 50
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apigateway:ModifyApi | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GroupId | string | 是 | 指定的分组编号 | 927d50c0f2e54b359919923d908bb015 |
ApiId | string | 是 | API 编号 | 8afff6c8c4c6447abb035812e4d66b65 |
ApiName | string | 是 | API 的名称,组内不允许重复。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,4~50 个字符 | ApiName |
Description | string | 否 | API 描述信息,最多 180 个字符 | Api description |
Visibility | string | 是 | API 是否公开,目前可以取值:
| PUBLIC |
AuthType | string | 否 | API 安全认证类型,目前可以取值:
| APP |
RequestConfig | string | 是 | Consumer 向网关发送 API 请求的相关配置项 | {"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""} |
ServiceConfig | string | 是 | 网关向后端服务发送 API 请求的相关配置项 | {"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"} |
ResultType | string | 是 | 后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。 该值仅用于生成文档使用。不对返回结果产生影响。 | HTML |
OpenIdConnectConfig | string | 否 | 第三方账号认证 OpenID Connect 相关配置项 | {\"OpenIdApiType\":\"IDTOKEN\",\"PublicKey\":\"lzlj1573\",\"IdTokenParamName\":\"\",\"PublicKeyId\":\"lzljorders\"} |
AllowSignatureMethod | string | 否 | API 的客户端请求签名方法,可选值:
| HmacSHA256 |
WebSocketApiType | string | 否 | 双向通信 API 类型:
| COMMON |
ResultBodyModel | string | 否 | api 的返回结果 | {} |
ForceNonceCheck | boolean | 否 |
| true |
DisableInternet | boolean | 否 |
说明
修改 API 时,不设置则不修改原来的取值。
| true |
AppCodeAuthType | string | 否 | 支持 AppCode 的认证类型。可选值:
| DEFAULT |
BackendId | string | 否 | 后端服务 ID | 0d105f80a8f340408bd34954d4e4ff22 |
BackendEnable | boolean | 否 | 是否启用后端服务 | true |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "6C87A26A-6A18-4B8E-8099-705278381A2C"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2024-01-26 | API 内部配置变更,不影响调用 | 看变更集 | ||
|