ModifyApi_API 网关_API调试-阿里云OpenAPI开发者门户

接口说明

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

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

请求参数

字段名称	字段详情
GroupIdstring	指定的分组编号示例值:927d50c0f2e54b359919923d908bb015参考取值来源: ModifyApiGroup CreateApiGroup DescribeApiGroups
ApiIdstring	API 编号示例值:8afff6c8c4c6447abb035812e4d66b65参考取值来源: CreateApi
ApiNamestring	API 的名称，组内不允许重复。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符示例值:ApiName参考取值来源: CreateApi DescribeApi
Descriptionstring	API 描述信息，最多 180 个字符示例值:Api description
Visibilitystring	API 是否公开，目前可以取值：展开详情示例值:PUBLIC
AuthTypestring	API 安全认证类型，目前可以取值：展开详情示例值: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]"}
RequestParametersstring	Consumer 向网关发送 API 请求的参数描述。展开详情示例值:[ { "ParameterLocation": { "name": "Head", "orderNumber": 2 }, "ParameterType": "String", "Required": "OPTIONAL", "isHide": false, "ApiParameterName": "header1", "DefaultValue": "123124", "Location": "Head" }, { "ParameterLocation": { "name": "Head", "orderNumber": 2 }, "ParameterType": "String", "Required": "REQUIRED", "isHide": false, "ApiParameterName": "header2", "DefaultValue": "", "Location": "Head" }, { "ParameterLocation": { "name": "Query", "orderNumber": 3 }, "ParameterType": "String", "Required": "OPTIONAL", "isHide": false, "ApiParameterName": "query1", "DefaultValue": "1245", "Location": "Query" }, { "ApiParameterName": "CaClientIp", "ParameterLocation": { "name": "Query", "orderNumber": 0 }, "Location": "Query", "ParameterType": "String", "Required": "REQUIRED", "Description": "ClientIP" }, { "ApiParameterName": "testConstant", "ParameterLocation": { "name": "Head", "orderNumber": 0 }, "Location": "Head", "ParameterType": "String", "Required": "REQUIRED", "DefaultValue": "111" } ]
SystemParametersstring	网关发送给后端服务的系统参数示例值:[{\"location\":\"HEAD\",\"parameterName\":\"CaDomain\",\"serviceParameterName\":\"host\"}]
ConstantParametersstring	网关发送给后端服务的常量参数示例值:[{\"ConstantValue\":\"123\",\"Description\":\"常量参数\",\"Location\":\"HEAD\",\"ServiceParameterName\":\"test\"}]
ServiceParametersstring	网关向后端服务发送 API 请求的参数描述。展开详情示例值:[ { "ServiceParameterName": "header1", "Location": "Head", "Type": "String", "ParameterCatalog": "REQUEST" }, { "ServiceParameterName": "header2", "Location": "Query", "Type": "String", "ParameterCatalog": "REQUEST" }, { "ServiceParameterName": "query1", "Location": "Head", "Type": "String", "ParameterCatalog": "REQUEST" }, { "ServiceParameterName": "ipp", "Location": "Query", "Type": "String", "ParameterCatalog": "SYSTEM" }, { "ServiceParameterName": "testConstant", "Location": "Head", "Type": "String", "ParameterCatalog": "CONSTANT" } ]
ServiceParametersMapstring	Consumer 向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系。展开详情示例值:[ { "ServiceParameterName": "header1", "RequestParameterName": "header1" }, { "ServiceParameterName": "header2", "RequestParameterName": "header2" }, { "ServiceParameterName": "query1", "RequestParameterName": "query1" }, { "ServiceParameterName": "ipp", "RequestParameterName": "CaClientIp" }, { "ServiceParameterName": "testConstant", "RequestParameterName": "testConstant" } ]
ResultTypestring	后端服务返回应答的格式，目前可以设置为：JSON、TEXT、BINARY、XML、HTML。展开详情示例值:HTML
ResultSamplestring	后端服务返回应答的示例该值仅用于生成文档使用。不对返回结果产生影响。示例值:{}
FailResultSamplestring	后端服务失败返回应答的示例。展开详情示例值:{\"requestId\":\"3b9b8b31-93c3-489e-8ebb-cab35a1aee51\",\"errCode\":500,\"errMsg\":\"connection refused\"}
ErrorCodeSamplesstring	后端服务返回的错误码示例。展开详情示例值:[{\"Code\":\"400\",\"Message\":\"Login failed\",\"Description\":\"Invalid user name or password\"}]
ResultDescriptionsstring	API 的返回说明示例值:{}
OpenIdConnectConfigstring	第三方账号认证 OpenID Connect 相关配置项示例值:{\"OpenIdApiType\":\"IDTOKEN\",\"PublicKey\":\"lzlj1573\",\"IdTokenParamName\":\"\",\"PublicKeyId\":\"lzljorders\"}
AllowSignatureMethodstring	API 的客户端请求签名方法，可选值：展开详情示例值:HmacSHA256
WebSocketApiTypestring	双向通信 API 类型：展开详情示例值:COMMON参考取值来源: DescribeApiHistory
ResultBodyModelstring	api 的返回结果示例值:{}
ForceNonceCheckboolean	设置 ForceNonceCheck 为 true, 请求时强制检查 X-Ca-Nonce，这个是请求的唯一标识，一般使用 UUID 来标识。API 网关收到这个参数后会校验这个参数的有效性，同样的值，15 分内只能被使用一次。可以有效防止 API 的重放攻击。展开详情示例值:true
DisableInternetboolean	设置 DisableInternet 为 true，仅支持内网调用 API。展开详情示例值:true
AppCodeAuthTypestring	支持 AppCode 的认证类型。可选值：展开详情示例值:DEFAULT
BackendIdstring	后端服务 ID 示例值:0d105f80a8f340408bd34954d4e4ff22参考取值来源: CreateBackend DescribeBackendList
BackendEnableboolean	是否启用后端服务示例值:true

返回参数

字段名称	字段详情
RequestIdstring	请求 ID 示例值:6C87A26A-6A18-4B8E-8099-705278381A2C

变更历史

暂无变更历史