CreateApi
新建一个 API
服务地址：
华东1 金融云
输入参数
只看必填
GroupId指定的分组编号
ApiName设置API的名称
VisibilityAPI是否公开
DescriptionAPI描述信息
AuthTypeAPI安全认证类型
RequestConfigConsumer向网关发送API请求的...
ServiceConfig网关向后端服务发送API请求的相关配置项
RequestParametersConsumer向网关发送API请求的...
SystemParameters网关发送给后端服务的系统参数
ConstantParameters网关发送给后端服务的常量参数
ServiceParameters网关向后端服务发送API请求的参数描述
ServiceParametersMapConsumer向网关发送请求的参数和...
ResultType后端服务返回应答的格式
ResultSample后端服务返回应答的示例
FailResultSample后端服务失败返回应答的示例
ErrorCodeSamples后端服务返回的错误码示例
ResultDescriptionsapi的返回说明
OpenIdConnectConfigip访问控制的开关状态
AllowSignatureMethod当AuthType为APP认证时
WebSocketApiType双向通信API类型：
ResultBodyModelapi的返回结果
ForceNonceCheck- 设置ForceNonceCheck...
请选择布尔值
DisableInternet- 设置DisableInternet...
请选择布尔值
AppCodeAuthType当AuthType为APP认证时
BackendId后端服务ID
BackendEnable是否启用后端服务
请选择布尔值
Tag指定规则所适用的对象标签
0
Key标签的键
Value标签的value
添加
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

  • 此接口面向开放 API 的用户。
  • 同一个分组内 API 不允许重名。
  • 同一个分组内 Path 不允许重复。
  • 该接口调用的 QPS 限制为：单用户 QPS 不超过 50。

请求参数

字段名称字段详情
GroupIdstring

指定的分组编号

示例值:08ae4aa0f95e4321849ee57f4e0b3077参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
ApiNamestring

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

示例值:ApiName参考取值来源:
    DescribeApi
Visibilitystring

API 是否公开，可以取值：展开详情

示例值:PUBLIC
Descriptionstring

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

示例值:Api description
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。默认为 JSON。

示例值:HTML
ResultSamplestring

后端服务返回应答的示例，该值仅用于生成文档使用。不对返回结果产生影响。(最大支持 32KB)

示例值:{}
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

ip 访问控制的开关状态，取值：-on：打开-off：关闭

示例值:{\"openIdApiType\":null,\"idTokenParamName\":null,\"publicKeyId\":null,\"publicKey\":null}
AllowSignatureMethodstring

当 AuthType 为 APP 认证时，需要传该值明确签名算法。可选值如下，不传默认是 HmacSHA256：展开详情

示例值:HmacSHA256
WebSocketApiTypestring

双向通信 API 类型：展开详情

示例值:COMMON参考取值来源:
    DescribeApiHistory
ResultBodyModelstring

api 的返回结果

示例值:{}
ForceNonceCheckboolean
  • 设置 ForceNonceCheck 为 true, 请求时强制检查 X-Ca-Nonce，这个是请求的唯一标识，一般使用 UUID 来标识。API 网关收到这个参数后会校验这个参数的有效性，同样的值，15 分内只能被使用一次。可以有效防止 API 的重放攻击。展开详情
示例值:true
DisableInternetboolean
  • 设置 DisableInternet 为 true, 仅支持内网调用 API。展开详情
示例值:true
AppCodeAuthTypestring

当 AuthType 为 APP 认证时，可选值如下：展开详情

示例值:HEADER
BackendIdstring

后端服务 ID

示例值:a0305308908c4740aba9cbfd63ba99b7参考取值来源:
    CreateBackend
    DescribeBackendList
BackendEnableboolean

是否启用后端服务

示例值:true
Tagarray<object>

指定规则所适用的对象标签，可设置多个。

子级条数 <= 100子级条数 >= 0

返回参数

字段名称字段详情
ApiIdstring

本次创建 API 的 ID

示例值:8afff6c8c4c6447abb035812e4d66b65
RequestIdstring

本次创建 API 的请求 ID

示例值:6C87A26A-6A18-4B8E-8099-705278381A2C
变更历史