DescribeApiHistory
查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义
服务地址：
华东1 金融云
输入参数
只看必填
GroupIdAPI分组ID
ApiId指定的API编号
StageName环境名称
HistoryVersion指定要查询的历史版本号
插件下载了解更多
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 定义。

  • 此功能面向开放 API 的用户。
  • 网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义详情。

请求参数

字段名称字段详情
GroupIdstring

API 分组 ID，系统生成，全局唯一。

示例值:3013a55c0c44483f984d26df27120513参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
ApiIdstring

指定的 API 编号。

示例值:dc6e17ee3120404c839bbcd7622ab6ed参考取值来源:
    CreateApi
StageNamestring

环境名称，取值为：展开详情

示例值:RELEASE
HistoryVersionstring

指定要查询的历史版本号。

示例值:20211122155403834参考取值来源:
    DescribeHistoryApis

返回参数

字段名称字段详情
Statusstring

api 调用状态

示例值:200
ApiIdstring

API 编号

示例值:bebf996e4b3d445d83078094b72b0d91
ResultTypestring

返回数据类型。

示例值:JSON
WebSocketApiTypestring

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

示例值:COMMON
DisableInternetboolean
  • 设置 DisableInternet 为 true, 仅支持内网调用 API。展开详情
示例值:true
ResultBodyModelstring

api 的返回结果

示例值:{}
ResultSamplestring

返回示例

示例值:{\n \"status\": 0,\n \"data\": {\n \"count\": 1,\n \"list\": [\n \"352\"\n ]\n },\n \"message\": \"success\"\n}
AppCodeAuthTypestring

支持 AppCode 的认证类型。可选值：展开详情

示例值:HEADER
AllowSignatureMethodstring

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

示例值:HmacSHA256
RegionIdstring

所在的 region

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

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

示例值:PUBLIC
FailResultSamplestring

后端服务失败返回应答的示例

示例值:{"errorCode":"fail","errorMessage":"param invalid"}
AuthTypestring

API 安全认证类型，目前可以取值：展开详情

示例值:APP
RequestIdstring

本次请求的 ID。

示例值:6C87A26A-6A18-4B8E-8099-705278381A2C
Descriptionstring

api 描述

示例值:根据地区名称查询天气情况
GroupNamestring

api 分组名称

示例值:dev_api
GroupIdstring

api 分组编号

示例值:cfb6ef799bf54fffabb0f02019ad2581
DeployedTimestring

发布时间(格林威治时间)

示例值:2021-06-1113:57:38
StageNamestring

API 发布的环境。展开详情

示例值:RELEASE
HistoryVersionstring

历史版本号

示例值:20211022134156663
ApiNamestring

Api 名称

示例值:测试API
BackendEnableboolean

是否启用后端服务

示例值:true
BackendConfigobject

后端配置

RequestConfigobject

Consumer 向网关发送 API 请求的相关配置项。展开详情

ServiceConfigobject

后端服务调用信息项

OpenIdConnectConfigobject

第三方账号认证 OpenID Connect 相关配置项

ErrorCodeSamplesobject
ResultDescriptionsobject
SystemParametersobject
CustomSystemParametersobject
ConstantParametersobject
RequestParametersobject
ServiceParametersobject
ServiceParametersMapobject
变更历史
暂无变更历史