文档

DescribeApiHistory - 查询历史版本详情

更新时间:

查询指定API的某一次历史发布版本的定义详情,即某一次历史发布时发布的API定义。

接口说明

查询指定API的某一次历史发布版本的定义详情,即某一次历史发布时发布的API定义。

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeApiHistoryRead
  • 全部资源
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
GroupIdstring

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

3013a55c0c44483f984d26df27120513
ApiIdstring

指定的API编号。

dc6e17ee3120404c839bbcd7622ab6ed
StageNamestring

环境名称,取值为:

  • RELEASE:线上
  • TEST:测试
  • PRE:预发
RELEASE
HistoryVersionstring

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

20211122155403834

返回参数

名称类型描述示例值
object
Statusstring

api调用状态

200
ApiIdstring

API编号

bebf996e4b3d445d83078094b72b0d91
ResultTypestring

返回数据类型。

JSON
WebSocketApiTypestring

双向通信API类型:

  • COMMON:普通API
  • REGISTER:注册API
  • UNREGISTER:注销API
  • NOTIFY:下行通知
COMMON
DisableInternetboolean
  • 设置DisableInternettrue, 仅支持内网调用API。
  • 设置DisableInternetfalse, 则不限制调用。创建API时默认为false。
true
ResultBodyModelstring

api的返回结果

{}
ResultSamplestring

返回示例

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

支持AppCode的认证类型。可选值:

  • DEFAULT:默认值:上架云市场后支持
  • DISABLE: 不支持AppCode调用方式
  • HEADER :仅在Header中支持
  • HEADER_QUERY :可以在Header或者Query中支持
HEADER
AllowSignatureMethodstring

AuthTypeAPP认证时,需要传该值明确签名算法。可选值如下,不传默认是HmacSHA256:

  • HmacSHA256
  • HmacSHA1,HmacSHA256
HmacSHA256
RegionIdstring

所在的region

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

  • 设置ForceNonceCheckfalse,则不检查。创建API时默认为false。

true
Visibilitystring

API是否公开,可以取值:

  • PUBLIC:公开,如选择此类型,该API的线上环境定义,会在所有用户的控制台“发现API”页面可见。
  • PRIVATE:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架。
PUBLIC
FailResultSamplestring

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

{"errorCode":"fail","errorMessage":"param invalid"}
AuthTypestring

API安全认证类型,目前可以取值:

  • APP:只允许已授权的APP调用
  • ANONYMOUS:允许匿名调用,设置为允许匿名调用需要注意:
    • 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按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: 线上
  • PRE: 预发
  • TEST: 测试
RELEASE
HistoryVersionstring

历史版本号

20211022134156663
ApiNamestring

Api名称

测试API
BackendEnableboolean

是否启用后端服务

true
BackendConfigobject

后端配置

BackendIdstring

后端服务ID

a0305308908c4740aba9cbfd63ba99b7
BackendTypestring

后端服务类型

HTTP
BackendNamestring

后端服务名称

zmapi
RequestConfigobject

Consumer向网关发送API请求的相关配置项。

更多信息,请参见RequestConfig

BodyModelstring

body模型

RequestPathstring

API path

/api/billing/test/[type]
RequestHttpMethodstring

HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS

POST
BodyFormatstring

POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:FORM、STREAM,分别表示表单形式(k-v对应)、字节流形式。当RequestMode值为MAPPING时有效。

STREAM
RequestModestring

入参请求的模式,取值为:

  • MAPPING:入参映射(过滤未知参数)

  • PASSTHROUGH:入参透传

  • MAPPING_PASSTHROUGH:入参映射(透传未知参数)

MAPPING
PostBodyDescriptionstring

请求body描述

fwefwef
RequestProtocolstring

API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:"HTTP,HTTPS",取值为:HTTP、HTTPS、WebSocket

HTTP
ServiceConfigobject

后端服务调用信息项

VpcIdstring

专用网络ID

vpc-uf6kg9x8sx2tbxxxx
MockStatusCodeinteger

Mock返回状态码

200
ContentTypeValuestring

调用后端服务HTTP服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值

application/json
ServiceProtocolstring

后端服务协议类型,目前只支持HTTP/HTTPS/FunctionCompute

HTTP
ServicePathstring

调用后端服务path

/object/add
ContentTypeCatagorystring

调用后端服务HTTP服务时,ContentType头的取值策略:

  • DEFAULT:使用API网关默认的值

  • CUSTOM:自定义

  • CLIENT:使用客户端上行的ContentType的头

CUSTOM
ServiceAddressstring

调用后端服务地址

http://api.a.com:8080
Mockstring

是否启用MOCK模式,目前可以取值:

  • TRUE:启用Mock模式

  • FALSE:不启用Mock模式

TRUE
ServiceVpcEnablestring

是否启用VPC通道,目前可以取值:

  • TRUE:启用VPC通道

  • FALSE:不启用VPC通道 必须先添加VPC授权成功后才能启用

TRUE
MockResultstring

如果启用Mock模式,返回的结果

test result
ServiceHttpMethodstring

调用后端服务HTTP协议时的Method,取值为:PUT、GET、POST、DELETE、PATCH、HEAD、OPTIONS、ANY。

POST
ServiceTimeoutinteger

后端服务超时时间,单位:毫秒

1000
MockHeadersobject []

模拟 Headers

HeaderValuestring

HTTP头参数值

86400
HeaderNamestring

HTTP头参数名

Content-Type
VpcConfigobject

VPC通道相关配置项

VpcIdstring

专用网络ID

vpc-2zeafsc3fygk1***
VpcSchemestring

VPC协议

HTTP
InstanceIdstring

专用网络中的实例ID(Ecs/负载均衡)

i-bp1h497hkijewv2***
Portinteger

实例对应的端口号

8080
Namestring

VPC名称

glmall-app-test
FunctionComputeConfigobject

后端为函数计算时的后端配置项

FcTypestring

函数计算服务类型

HttpTrigger
RoleArnstring

Ram授权给API网关访问函数计算的arn

acs:ram::111***:role/aliyunserviceroleforsas
Methodstring

请求方法

GET
FcBaseUrlstring

函数计算服务根路径

https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/
ContentTypeValuestring

调用后端服务HTTP服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值。

application/json
RegionIdstring

地域ID

cn-hangzhou
OnlyBusinessPathboolean

后端只接收业务path

false
FunctionNamestring

函数计算定义的FunctionName

domain_business_control
ContentTypeCatagorystring

调用后端服务HTTP服务时,ContentType头的取值策略:

  • DEFAULT:使用API网关默认的值
  • CUSTOM:自定义
  • CLIENT:使用客户端上行的ContentType的头
DEFAULT
Pathstring

API请求路径

/api/offline/cacheData
ServiceNamestring

函数计算定义的ServiceName

fcservicename
Qualifierstring

函数别名

2
OssConfigobject

后端为OSS的信息

OssRegionIdstring

OSS服务所在地域ID。

cn-hangzhou
BucketNamestring

OSS存储Bucket。

phototest02
EventBridgeConfigobject

事件总线设置

EventBridgeRegionIdstring

事件总线服务所在区域ID

cn-beijing
EventBusstring

事件总线

testBus
EventSourcestring

事件来源。

baas_driver
RoleArnstring

Ram授权给EventBridge的arn

acs:ram::1933122015759***:role/adminoidcaliyun
OpenIdConnectConfigobject

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

OpenIdApiTypestring

OpenID Connect模式,目前可以取值:

  • IDTOKEN:获取授权API,颁发Token,当设置此项时,参数PublicKeyId和PublicKey为必传。
  • BUSINESS:业务API,Token验证,当设置此项时,参数IdTokenParamName为必传。
IDTOKEN
IdTokenParamNamestring

Token对应的参数名称

xxx
PublicKeyIdstring

公钥id

88483727556929326703309904351185815489
PublicKeystring

api公钥

EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92
ErrorCodeSamplesobject []

后端服务返回的错误码示例。

更多信息,请参见ErrorCodeSample

Codestring

错误码

400
Messagestring

错误消息

MissingParameter
Descriptionstring

描述信息

Missing the parameter UserId
ResultDescriptionsobject []

api的返回说明

Typestring

结果类型。

String
Keystring

结果主键。

groupName
HasChildboolean

是否有子节点。

true
Descriptionstring

描述信息

for_test1
Pidstring

父节点 ID。

pid
Mandatoryboolean

是否必填。

true
Namestring

结果名。

fwqf
Idstring

结果 ID。

id
SystemParametersobject []

api的公共参数,json格式

DemoValuestring

示例值。

192.168.1.1
Descriptionstring

描述信息。

system parameters description
ParameterNamestring

系统参数名,取值为:CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy。

CaClientIp
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ServiceParameterNamestring

对应后端参数名称

clientIp
CustomSystemParametersobject []

自定义系统参数列表

DemoValuestring

示例值

192.168.1.1
Descriptionstring

自定义系统参数描述

balabala
ParameterNamestring

自定义系统参数名

CaClientIp
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ServiceParameterNamestring

对应后端参数名称

clientIp
ConstantParametersobject []

常量参数列表

Descriptionstring

描述信息

for_test1
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ServiceParameterNamestring

后端参数名称

constance
ConstantValuestring

常量值

constance
RequestParametersobject []

Consumer向网关发送API请求的参数描述。

更多信息,请参见RequestParameter

JsonSchemestring

JSON scheme

{}
MaxValuelong

ParameterType=Int、Long、Float、Double,参数的最大值限定

123456
ArrayItemsTypestring

数组元素的类型

String
MinValuelong

ParameterType=Int、Long、Float、Double,参数的最小值限定

123456
DocShowstring

文档可见,取值为:PUBLICPRIVATE

PUBLIC
MaxLengthlong

ParameterType=String,参数的最大长度限定

123456
DefaultValuestring

默认值

20
ApiParameterNamestring

API 参数名称

age
EnumValuestring

ParameterType=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F。

boy,girl
DemoValuestring

示例

20
Requiredstring

是否必填,取值为:REQUIREDOPTIONAL,分别表示必填、不必填

OPTIONAL
Descriptionstring

描述信息

modidyTest
ParameterTypestring

参数类型,取值为:String、Int、Long、Float、Double、Boolean,分别表示字符、整型、长整型、单精度浮点型、双精度浮点型、布尔。

String
RegularExpressionstring

ParameterType=String,参数验证(正则表达式)

xxx
MinLengthlong

ParameterType=String,参数的最小长度限定

123456
DocOrderinteger

文档中顺序

0
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ServiceParametersobject []

网关向后端服务发送API请求的参数描述。

更多信息,请参见ServiceParameter

Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ParameterTypestring

后端参数数据类型,取值为:STRING、NUMBER、BOOLEAN,分别表示字符、数值、布尔。

String
ServiceParameterNamestring

后端参数名称

clientIp
ServiceParametersMapobject []

Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系。

更多信息,请参见ServiceParameterMap

RequestParameterNamestring

对应前端入参名称,这个值必须存在于RequestParametersObject中,匹配于RequestParam.ApiParameterName。

sex
ServiceParameterNamestring

后端参数名称

sex

示例

正常返回示例

JSON格式

{
  "Status": "200",
  "ApiId": "bebf996e4b3d445d83078094b72b0d91",
  "ResultType": "JSON",
  "WebSocketApiType": "COMMON",
  "DisableInternet": true,
  "ResultBodyModel": "{}",
  "ResultSample": "{\\n  \\\"status\\\": 0,\\n  \\\"data\\\": {\\n    \\\"count\\\": 1,\\n    \\\"list\\\": [\\n      \\\"352\\\"\\n    ]\\n  },\\n  \\\"message\\\": \\\"success\\\"\\n}",
  "AppCodeAuthType": "HEADER",
  "AllowSignatureMethod": "HmacSHA256",
  "RegionId": "cn-hangzhou",
  "ForceNonceCheck": true,
  "Visibility": "PUBLIC",
  "FailResultSample": "{\"errorCode\":\"fail\",\"errorMessage\":\"param invalid\"}",
  "AuthType": "APP",
  "RequestId": "6C87A26A-6A18-4B8E-8099-705278381A2C",
  "Description": "根据地区名称查询天气情况",
  "GroupName": "dev_api",
  "GroupId": "cfb6ef799bf54fffabb0f02019ad2581",
  "DeployedTime": "2021-06-1113:57:38",
  "StageName": "RELEASE",
  "HistoryVersion": "20211022134156663",
  "ApiName": "测试API",
  "BackendEnable": true,
  "BackendConfig": {
    "BackendId": "a0305308908c4740aba9cbfd63ba99b7",
    "BackendType": "HTTP",
    "BackendName": "zmapi"
  },
  "RequestConfig": {
    "BodyModel": "",
    "RequestPath": "/api/billing/test/[type]",
    "RequestHttpMethod": "POST",
    "BodyFormat": "STREAM",
    "RequestMode": "MAPPING",
    "PostBodyDescription": "fwefwef",
    "RequestProtocol": "HTTP"
  },
  "ServiceConfig": {
    "VpcId": "vpc-uf6kg9x8sx2tbxxxx",
    "MockStatusCode": 200,
    "ContentTypeValue": "application/json",
    "ServiceProtocol": "HTTP",
    "ServicePath": "/object/add",
    "ContentTypeCatagory": "CUSTOM",
    "ServiceAddress": "http://api.a.com:8080",
    "Mock": "TRUE",
    "ServiceVpcEnable": "TRUE",
    "MockResult": "test result",
    "ServiceHttpMethod": "POST",
    "ServiceTimeout": 1000,
    "MockHeaders": {
      "MockHeader": [
        {
          "HeaderValue": "86400",
          "HeaderName": "Content-Type"
        }
      ]
    },
    "VpcConfig": {
      "VpcId": "vpc-2zeafsc3fygk1***",
      "VpcScheme": "HTTP",
      "InstanceId": "i-bp1h497hkijewv2***",
      "Port": 8080,
      "Name": "glmall-app-test"
    },
    "FunctionComputeConfig": {
      "FcType": "HttpTrigger",
      "RoleArn": "acs:ram::111***:role/aliyunserviceroleforsas",
      "Method": "GET",
      "FcBaseUrl": "https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/",
      "ContentTypeValue": "application/json",
      "RegionId": "cn-hangzhou",
      "OnlyBusinessPath": false,
      "FunctionName": "domain_business_control",
      "ContentTypeCatagory": "DEFAULT",
      "Path": "/api/offline/cacheData",
      "ServiceName": "fcservicename",
      "Qualifier": "2"
    },
    "OssConfig": {
      "Key": "",
      "Action": "",
      "OssRegionId": "cn-hangzhou",
      "BucketName": "phototest02"
    },
    "EventBridgeConfig": {
      "EventBridgeRegionId": "cn-beijing",
      "EventBus": "testBus",
      "EventSource": "baas_driver",
      "RoleArn": "acs:ram::1933122015759***:role/adminoidcaliyun"
    }
  },
  "OpenIdConnectConfig": {
    "OpenIdApiType": "IDTOKEN",
    "IdTokenParamName": "xxx",
    "PublicKeyId": "88483727556929326703309904351185815489",
    "PublicKey": "EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92"
  },
  "ErrorCodeSamples": {
    "ErrorCodeSample": [
      {
        "Code": "400",
        "Message": "MissingParameter",
        "Description": "Missing the parameter UserId"
      }
    ]
  },
  "ResultDescriptions": {
    "ResultDescription": [
      {
        "Type": "String",
        "Key": "groupName",
        "HasChild": true,
        "Description": "for_test1",
        "Pid": "pid",
        "Mandatory": true,
        "Name": "fwqf",
        "Id": "id"
      }
    ]
  },
  "SystemParameters": {
    "SystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "system parameters description",
        "ParameterName": "CaClientIp",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "CustomSystemParameters": {
    "CustomSystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "balabala",
        "ParameterName": "CaClientIp",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ConstantParameters": {
    "ConstantParameter": [
      {
        "Description": "for_test1",
        "Location": "HEAD",
        "ServiceParameterName": "constance",
        "ConstantValue": "constance"
      }
    ]
  },
  "RequestParameters": {
    "RequestParameter": [
      {
        "JsonScheme": "{}",
        "MaxValue": 123456,
        "ArrayItemsType": "String",
        "MinValue": 123456,
        "DocShow": "PUBLIC",
        "MaxLength": 123456,
        "DefaultValue": "20",
        "ApiParameterName": "age",
        "EnumValue": "boy,girl",
        "DemoValue": "20",
        "Required": "OPTIONAL",
        "Description": "modidyTest",
        "ParameterType": "String",
        "RegularExpression": "xxx",
        "MinLength": 123456,
        "DocOrder": 0,
        "Location": "HEAD"
      }
    ]
  },
  "ServiceParameters": {
    "ServiceParameter": [
      {
        "Location": "HEAD",
        "ParameterType": "String",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ServiceParametersMap": {
    "ServiceParameterMap": [
      {
        "RequestParameterName": "sex",
        "ServiceParameterName": "sex"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈