插件下载了解更多
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 IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
流控信息
请求速率为100/1(s)。更多流控信息，请前往配额中心查看
请求参数
| 字段名称 | 字段详情 |
|---|---|
ApiIdstring | API 的 ID 标识 示例值:baacc592e63a4cb6a41920d9d3f91f38参考取值来源: CreateApi |
ApiNamestring | API 名称 示例值:testModifyApiName参考取值来源: CreateApi DescribeApi |
Descriptionstring | api 描述 示例值:测试修改描述 |
Visibilitystring | API 是否公开，可以取值：展开详情 示例值:PUBLIC |
ForceNonceCheckboolean |
示例值:true |
DisableInternetboolean |
示例值:false |
AppCodeAuthTypestring | 当 AuthType 为 APP 认证时，可选值如下：展开详情 示例值:DEFAULT |
AllowSignatureMethodstring | 当 AuthType 为 APP 认证时，需要传该值明确签名算法。可选值如下，不传默认是 HmacSHA256：展开详情 示例值:HmacSHA256 |
AuthTypestring | API 安全认证类型，目前可以取值：展开详情 示例值:APP |
RequestProtocolstring | API 支持的协议类型，可以多选，多选情况下以英文逗号隔开，如：”HTTP,HTTPS”，取值为：HTTP、HTTPS。 示例值:HTTP参考取值来源: QueryRequestLogs |
RequestHttpMethodstring | HTTP Method，取值为：GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。 示例值:GET |
RequestPathstring | API path，比如 API 的完全地址为 示例值:/test/api |
RequestModestring | 入参请求的模式，取值为：展开详情 示例值:MAPPING |
BodyFormatstring | 当 RequestMode 值为 MAPPING 时有效。展开详情 示例值:STREAM |
PostBodyDescriptionstring | 请求 body 描述 示例值:body描述 |
BodyModelstring | body 模型 示例值:https://apigateway.aliyun.com/models/f4e7333c****40dcbaf7c9da553ccd8d/3ab61f775b****d4bc35e993****87aa8 |
ModelNamestring | 模型的名称 示例值:Test参考取值来源: CreateModel DescribeModels |
BackendNamestring | 后端服务名称展开详情 示例值:testBackendService参考取值来源: CreateBackend DescribeBackendInfo |
ServiceProtocolstring | 后端服务协议类型，目前支持：展开详情 示例值:HTTP |
HttpConfigstring | http 配置信息 示例值:{"serviceAddress":"http://test.api.com","servicePath":"/test/api","serviceHttpMethod":"GET"} |
VpcConfigstring | vpc 配置 示例值:{"VpcId":"vpc-xxxxxxx","Name":"testVpc","InstanceId":"i-p0ssssss","Port":80,"servicePath":"/test/vpc","serviceHttpMethod":"HEAD"} |
FunctionComputeConfigstring | 函数计算配置信息 示例值:{"FcType":"FCEvent","FcRegionId":"cn-hangzhou","RoleArn":"acs:ram::xxxxxxxx:role/aliyunserviceroleforapigateway","selectServiceName":"fcTest","FunctionName":"funcTest","selectFunctionName":"funcTest","Qualifier":"LATEST","Path":"","FcBaseUrl":"","ServiceName":"fcTest"} |
OssConfigstring | OSS 配置信息 示例值:{"OssRegionId":"cn-hangzhou","Key":"/test.html","BucketName":"test-api-oss","Action":"GetObject"} |
MockConfigstring | Mock 配置信息 示例值:{"MockResult":"test","MockHeaders":[{"HeaderName":"testHeader","HeaderValue":"testHeader"}],"MockStatusCode":"400"} |
ServiceTimeoutinteger<int32> | 后端服务超时时间，单位：毫秒 示例值:10000 |
ContentTypeCategorystring | 后端请求 ContentType 配置展开详情 示例值:DEFAULT |
ContentTypeValuestring | 调用后端服务 HTTP 服务，ContentTypeCatagory 的值为 DEFAULT 或者 CUSTOM 时，ContentType 头的取值。 示例值:application/x-www-form-urlencoded; charset=UTF-8 |
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"}] |
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 |
ResultSamplestring | 后端服务返回应答的示例展开详情 示例值:{\n \"status\": 0,\n \"data\": {\n \"count\": 1,\n \"list\": [\n \"352\"\n ]\n },\n \"message\": \"success\"\n} |
FailResultSamplestring | 后端服务失败返回应答的示例展开详情 示例值:{"errorCode":"fail","errorMessage":"param invalid"} |
ErrorCodeSamplesstring | 后端服务返回的错误码示例。展开详情 示例值:[{"Code":"400","Message":"Missing the userId","Description":"param invalid"}] |
UseBackendServiceboolean | 是否使用创建的后端服务资源：展开详情 示例值:TRUE |
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 请求 id 示例值:6C87A26A-6A18-4B8E-8099-705278381A2C |
返回示例
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2022-04-24 |