942
英雄联盟
修改API__API管理相关接口_API_API 网关-阿里云
修改API(ModifyApi)
描述
修改API定义
- 此接口面向开放API的用户
- 修改ApiName时需要注意,同一个分组内API不允许重名
- 修改RequestPath时需要注意,同一个分组内Path不允许重复
- 该接口调用的QPS限制为:单用户QPS不超过50
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 操作接口名,系统规定参数,取值:ModifyApi |
GroupId | String | 是 | 指定的分组编号 |
ApiId | String | 是 | API的Id标识 |
ApiName | String | 是 | API的名称,组内不允许重复。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,4~50个字符 |
Visibility | String | 是 | API是否公开,目前可以取值:
|
Description | String | 是 | API描述信息,最多180个字符 |
AuthType | String | 是 | API安全认证类型,目前可以取值:
|
OpenIdConnectConfig | String | 是 | 第三方账号认证OpenID Connect相关配置项,详情见ApiAttributesType.md#OpenIdConnectConfig |
RequestConfig | String | 是 | Consumer向网关发送API请求的相关配置项,详情见ApiAttributesType.md#RequestConfig |
ServiceConfig | String | 是 | 网关向后端服务发送API请求的相关配置项,详情见ApiAttributesType.md#ServiceConfig |
RequestParameters | String | 是 | Consumer向网关发送API请求的参数描述,详情见ApiAttributesType.md#RequestParameters |
ServiceParameters | String | 是 | 网关向后端服务发送API请求的参数描述,详情见ApiAttributesType.md#ServiceParameters |
ServiceParametersMap | String | 是 | Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系,详情见ApiAttributesType.md#ServiceParametersMap |
ResultType | String | 是 | 后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML |
ResultSample | String | 是 | 后端服务返回应答的示例 |
FailResultSample | String | 否 | 后端服务失败返回应答的示例 |
ErrorCodeSamples | String | 否 | 后端服务返回的错误码示例,详情见ApiAttributesType.md#ErrorCodeSamples |
返回参数
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 本次创建API的请求Id |
示例
请求示例
https://ecs.aliyuncs.com/?Action=ModifyApi
&GroupId=08ae4aa0f95e4321849ee57f4e0b3077
&ApiName=ApiName
&ApiId=8afff6c8c4c6447abb035812e4d66b65
&Visibility=PUBLIC
&Description=Api description
&AuthType=APP
&RequestConfig={"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}
&ServiceConfig={"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"https://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}
&RequestParameters=[{"ParameterLocation":{"name":"Head","orderNumber":1},"ParameterType":"Number","Required":"OPTIONAL","isHide":false,"ApiParameterName":"age","DefaultValue":"20","DemoValue":"20","Description":"年龄","MinValue":18,"MaxValue":100,"Location":"Head"},{"ParameterLocation":{"name":"Query","orderNumber":2},"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"sex","DefaultValue":"boy","DemoValue":"boy","Description":"性别","EnumValue":"boy,girl","Location":"Query"},{"ParameterLocation":{"name":"Parameter Path","orderNumber":3},"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"}]
&ServiceParameters=[{"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"}]
&ServiceParametersMap=[{"ServiceParameterName":"age","RequestParameterName":"age"},{"ServiceParameterName":"sex","RequestParameterName":"sex"},{"ServiceParameterName":"userId","RequestParameterName":"userId"},{"ServiceParameterName":"clientIp","RequestParameterName":"CaClientIp"},{"ServiceParameterName":"constance","RequestParameterName":"constance"}]
&ResultType=HTML
&ResultSample=200
&<公共请求参数>
返回示例
XML
格式
<ModifyApiResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</ModifyApiResponse>
JSON
格式
{
"RequestId":"6C87A26A-6A18-4B8E-8099-705278381A2C"
}
最后更新:2016-12-15 09:04:14
上一篇:
删除域名证书__域名相关接口_API_API 网关-阿里云
下一篇:
快速切换API版本__API管理相关接口_API_API 网关-阿里云
常见错误说明__附录_大数据计算服务-阿里云
发送短信接口__API使用手册_短信服务-阿里云
接口文档__Android_安全组件教程_移动安全-阿里云
运营商错误码(联通)__常见问题_短信服务-阿里云
设置短信模板__使用手册_短信服务-阿里云
OSS 权限问题及排查__常见错误及排除_最佳实践_对象存储 OSS-阿里云
消息通知__操作指南_批量计算-阿里云
设备端快速接入(MQTT)__快速开始_阿里云物联网套件-阿里云
查询API调用流量数据__API管理相关接口_API_API 网关-阿里云
使用STS访问__JavaScript-SDK_SDK 参考_对象存储 OSS-阿里云