插件下载了解更多
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.
接口说明
- 此接口面向开放 API 的用户
流控信息
请求速率为100/1(s)。更多流控信息,请前往配额中心查看
请求参数
字段名称 | 字段详情 |
---|---|
GroupIdstring | API 所在的分组编号 示例值:123参考取值来源: ModifyApiGroup CreateApiGroup DescribeApiGroups |
ApiIdstring | API 的 ID 标识 示例值:8afff6c8c4c6447abb035812e4d66b65参考取值来源: CreateApi |
返回参数
字段名称 | 字段详情 |
---|---|
ApiIdstring | API 的 ID 标识 示例值:8afff6c8c4c6447abb035812e4d66b65 |
ResultTypestring | 后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。 示例值:JSON |
WebSocketApiTypestring | 双向通信 API 类型:展开详情 示例值:COMMON |
DisableInternetboolean | API 是否仅支持内网调用, 取值:展开详情 示例值:false |
ResultBodyModelstring | api 的返回结果 示例值:{} |
ResultSamplestring | 后端服务返回应答的示例 示例值:200 |
AppCodeAuthTypestring | 当 AuthType 为 APP 认证时,可选值如下:展开详情 示例值:HEADER |
AllowSignatureMethodstring | 当 AuthType 为 APP 认证时,需要传该值明确签名算法。可选值如下,不传默认是 HmacSHA256:展开详情 示例值:HmacSHA256 |
RegionIdstring | API 所处的 Region 的 ID 示例值:cn-qingdao |
ForceNonceCheckboolean | 调用 API 时是否必须携带 header : X-Ca-Nonce, 这个是请求的唯一标识,一般使用 UUID 来标识。API 网关收到这个参数后通过校验这个参数的有效性可以有效防止 API 的重放攻击,同样的值,15 分内只能被使用一次。 取值:展开详情 示例值:true |
Visibilitystring | API 是否公开,目前可以取值:展开详情 示例值:PUBLIC |
FailResultSamplestring | 后端服务失败返回应答的示例 示例值:400 |
AuthTypestring | API 安全认证类型,目前可以取值:展开详情 示例值:APP |
ModifiedTimestring | API 最后一次修改的时间 示例值:2016-07-28T13:13:12Z |
RequestIdstring | 请求 ID 示例值:D0FF585F-7966-40CF-BC60-75DB070B23D5< |
Descriptionstring | API 描述信息 示例值:Api description |
GroupNamestring | API 所在的分组名称 示例值:ApiTest |
GroupIdstring | API 所在的分组编号 示例值:08ae4aa0f95e4321849ee57f4e0b3077 |
Mockstring | 是否启用 MOCK 模式,目前可以取值:展开详情 示例值:CLOSED |
MockResultstring | Mock 返回结果 示例值:test result |
CreatedTimestring | API 创建的时间 示例值:2016-07-28T09:50:43Z |
ApiNamestring | API 的名称,组内不允许重复 示例值:ApiName |
BackendEnableboolean | 是否启用后端服务 示例值:true |
BackendConfigobject | 后端配置 |
RequestConfigobject | Consumer 向网关发送 API 请求的相关配置项 |
ServiceConfigobject | 网关向后端服务发送 API 请求的相关配置项 |
OpenIdConnectConfigobject | 第三方账号认证 OpenID Connect 相关配置项 |
ErrorCodeSamplesobject | |
SystemParametersobject | |
CustomSystemParametersobject | |
ConstantParametersobject | |
RequestParametersobject | |
ServiceParametersobject | |
ServiceParametersMapobject | |
DeployedInfosobject | |
TagListobject |