閱讀206 返回首頁    go 阿裏雲 go 技術社區[雲棲]

查詢曆史版本詳情__API管理相關接口_API_API 網關-阿裏雲

查詢指定API的指定曆史版本的定義詳情（DescribeApiHistory）

描述

查詢指定API的某一次曆史發布版本的定義詳情，即某一次曆史發布時發布的API定義。

  • 此功能麵向開放API的用戶
  • 網關會記錄下每個API每一次發布的時間、定義等等，您可以通過其他的接口獲取版本號來指定查詢某一次發布的定義詳情

請求參數

名稱 類型 是否必須 描述
Action String 是 操作接口名，係統規定參數，取值：DescribeApiHistory
GroupId String 是 指定的分組編號
ApiId String 是 指定的API編號
StageName String 是 環境名稱，可選值：
  • RELEASE: 線上
  • TEST: 測試
HistoryVersion String 是 指定的版本號(從DescribeHistoryApis接口可以獲取到版本號)

返回參數

名稱 類型 描述
RequestId String 本次請求編號
RegionId String 所在的region
GroupId String API分組編號
GroupName String API分組名稱
StageName String 環境名稱，可選值：
  • RELEASE: 線上
  • TEST: 測試
ApiId String API編號
ApiName String API名稱
Description String API描述
HistoryVersion String API定義的版本號
Status String 對應版本的API是否生效，取值為：ENABLE、DISABLE，分別表示有效、無效
Visibility String 可見性，取值為：PUBLIC、PRIVATE，分別表示公開、私有
AuthType String 安全認證方式，取值為：APP、ANONYMOUS、APPOPENID，分別表示阿裏雲APP、匿名、第三方賬號認證OpenID Connect
ResultType String 返回類型
ResultSample String 返回示例
FailResultSample String 後端服務失敗返回應答的示例
DeployedTime String 發布時間(格林威治時間)
ErrorCodeSamples ErrorCodeSample 後端服務返回的錯誤碼示例，詳情見ApiAttributesType.md#ErrorCodeSamples
RequestConfig RequestConfig 由 RequestConfig 組成的格式，返回API前端定義信息
ServiceConfig ServiceConfig 由 ServiceConfig 組成的格式，返回API調用後端服務信息
SystemParameters SystemParameter 由 SystemParameter 組成的數組格式，返回API中調用後端服務時係統入參信息項
ConstantParameters ConstantParameter 由 ConstantParameter 組成的數組格式，返回API中調用後端服務時常量入參信息項
RequestParameters RequestParameter 由 RequestParameter 組成的數組格式，返回API中前端入參信息項
ServiceParameters ServiceParameter 由 ServiceParameter 組成的數組格式，返回API中調用後端服務時常量入參信息項
ServiceParametersMap ServiceParameterMap 由 ServiceParameterMap 組成的數組格式，返回API中前後端參數映射關係
OpenIdConnectConfig OpenIdConnectConfig 第三方賬號認證OpenID Connect相關配置項，詳情見ApiAttributesType.md#OpenIdConnectConfig

示例

請求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiHistory
  2. &GroupId=0009db9c828549768a200320714b8930
  3. &ApiId=3b81fd160f5645e097cc8855d75a1cf6
  4. &StageName=RELEASE
  5. &HistoryVersion=20160314220059844
  6. &<公共請求參數>

返回示例

XML格式

  1. <DescribeApiHistoryResponse>
  2.     <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3.     <RegionId>cn-qingdao</RegionId>
  4.     <GroupId>0009db9c828549768a200320714b8930</GroupId>
  5.     <GroupName>myGroup2</GroupName>
  6.     <StageName>RELEASE</StageName>
  7.     <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>
  8.     <ApiName>creatobject</ApiName>
  9.     <Description>對象創建</Description>
  10.     <HistoryVersion>20160314220059844</HistoryVersion>
  11.     <Status>DISABLE</Status>
  12.     <Visibility>public</Visibility>
  13.     <AuthType>APP</AuthType>
  14.     <ResultType>application/json</ResultType>
  15.     <ResultSample></ResultSample>
  16.     <FailResultSample></FailResultSample>
  17.     <DeployedTime>2016-07-23T08:28:48Z</DeployedTime>
  18.     <RequestConfig>
  19.         <RequestProtocol>HTTP</RequestProtocol>
  20.         <RequestHttpMethod>GET</RequestHttpMethod>
  21.         <RequestPath>/mypath/creatobject</RequestPath>
  22.         <BodyFormat>FORM</BodyFormat>
  23.         <PostBodyDescription>對象</PostBodyDescription>
  24.     </RequestConfig>
  25.     <ServiceConfig>
  26.         <ServiceProtocol>HTTP/HTTPS</ServiceProtocol>
  27.         <ServiceAddress>https://api.a.com:8080</ServiceAddress>
  28.         <ServiceHttpMethod>GET</ServiceHttpMethod>
  29.         <ServicePath>/object/add</ServicePath>
  30.         <ServiceTimeout>2000</ServiceTimeout>
  31.     </ServiceConfig>
  32.     <SystemParameters>
  33.         <SystemParameter>
  34.             <ParameterName>CaRequestId</ParameterName>
  35.             <ServiceParameterName>RequestId</ServiceParameterName>
  36.             <Location>HEAD</Location>
  37.             <DemoValue>0A964636-F7A3-4F1A-92D7-135584A6397F</DemoValue>
  38.             <Description>請求編號</Description>
  39.         </SystemParameter>
  40.         <SystemParameter>
  41.             <ParameterName>CaAppId</ParameterName>
  42.             <ServiceParameterName>AppId</ServiceParameterName>
  43.             <Location>QUERY</Location>
  44.             <DemoValue>0A964636-F7A3-4F1A-92D7-135584A6398F</DemoValue>
  45.             <Description>請求者應用編號</Description>
  46.         </SystemParameter>
  47.     </SystemParameters>
  48.     <ConstantParameters>
  49.         <ConstantParameter>
  50.             <ServiceParameterName>ConstantKey1</ServiceParameterName>
  51.             <ConstantValue>helloworld</ConstantValue>
  52.             <Location>QUERY</Location>                
  53.             <Description>Desc</Description>
  54.         </ConstantParameter>
  55.     </ConstantParameters>
  56.     <RequestParameters>
  57.         <RequestParameter>
  58.             <ApiParameterName>RequestKey1</ApiParameterName>
  59.             <Location>QUERY</Location>                
  60.             <ParameterType>String</ParameterType>
  61.             <Required>REQUIRED</Required>
  62.             <DefaultValue></DefaultValue>
  63.             <DemoValue>demo1</DemoValue>
  64.             <MaxValue></MaxValue>
  65.             <MinValue></MinValue>
  66.             <MaxLength>100</MaxLength>
  67.             <MinLength>3</MinLength>
  68.             <RegularExpression></RegularExpression>
  69.             <JsonScheme></JsonScheme>
  70.             <EnumValue></EnumValue>
  71.             <DocShow>PUBLIC</DocShow>
  72.             <DocOrder>1</DocOrder>
  73.             <Description>Desc1</Description>
  74.         </RequestParameter>
  75.         <RequestParameter>
  76.             <ApiParameterName>RequestKey2</ApiParameterName>
  77.             <Location>QUERY</Location>                
  78.             <ParameterType>Number</ParameterType>
  79.             <Required>OPTIONAL</Required>
  80.             <DefaultValue></DefaultValue>
  81.             <DemoValue>12</DemoValue>
  82.             <MaxValue>120</MaxValue>
  83.             <MinValue>100</MinValue>
  84.             <MaxLength></MaxLength>
  85.             <MinLength></MinLength>
  86.             <RegularExpression></RegularExpression>
  87.             <JsonScheme></JsonScheme>
  88.             <EnumValue></EnumValue>
  89.             <DocShow>PUBLIC</DocShow>
  90.             <DocOrder>2</DocOrder>
  91.             <Description>Desc2</Description>
  92.         </RequestParameter>
  93.     </RequestParameters>
  94.     <ErrorCodeSamples>
  95.         <ErrorCodeSample>
  96.             <Code>400</Code>
  97.             <Message>Missing the parameter UserId</Message>
  98.             <Description>請求缺少參數 UserId</Description>
  99.         </ErrorCodeSample>
  100.     </ErrorCodeSamples>
  101.     <ServiceParameters>
  102.         <ServiceParameter>
  103.             <ServiceParameterName>ServiceKey1</ServiceParameterName>
  104.             <Location>QUERY</Location>                
  105.             <ParameterType>String</ParameterType>
  106.         </ServiceParameter>
  107.         <ServiceParameter>
  108.             <ServiceParameterName>ServiceKey2</ServiceParameterName>
  109.             <Location>QUERY</Location>                
  110.             <ParameterType>Number</ParameterType>
  111.         </ServiceParameter>
  112.     </ServiceParameters>
  113.     <ServiceParametersMap>
  114.         <ServiceParameterMap>
  115.             <ServiceParameterName>RequestKey1</ServiceParameterName>
  116.             <RequestParameterName>ServiceKey1</RequestParameterName>
  117.         </ServiceParameterMap>
  118.         <ServiceParameterMap>
  119.             <ServiceParameterName>RequestKey2</ServiceParameterName>
  120.             <RequestParameterName>ServiceKey2</RequestParameterName>
  121.         </ServiceParameterMap>
  122.     </ServiceParametersMap>
  123.     <OpenIdConnectConfig>
  124.         <publicKey>EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92</publicKey>
  125.         <openIdApiType>IDTOKEN</openIdApiType>
  126.         <publicKeyId>88483727556929326703309904351185815489</publicKeyId>
  127.     </OpenIdConnectConfig>
  128. </DescribeApiHistoryResponse>

JSON格式

  1. {
  2.     "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3.     "RegionId": "cn-qingdao",
  4.     "GroupId": "0009db9c828549768a200320714b8930",
  5.     "GroupName": "myGroup2",
  6.     "StageName": "RELEASE",
  7.     "ApiId": "3b81fd160f5645e097cc8855d75a1cf6",
  8.     "ApiName": "creatobject",
  9.     "Description": "對象創建",
  10.     "HistoryVersion": "20160314220059844",
  11.     "Status": "DISABLE",
  12.     "Visibility": "public",
  13.     "AuthType": "APP",
  14.     "ResultType": "application/json",
  15.     "ResultSample": "200",
  16.     "FailResultSample": "400",
  17.     "DeployedTime": "2016-07-23T08:28:48Z",
  18.     "RequestConfig": {
  19.       "RequestProtocol": "HTTP",
  20.       "RequestHttpMethod": "GET",
  21.       "RequestPath": "/mypath/creatobject",
  22.       "BodyFormat": "FORM",
  23.       "PostBodyDescription": "對象"
  24.     },
  25.     "ServiceConfig": {
  26.       "ServiceProtocol": "HTTP/HTTPS",
  27.       "ServiceAddress": "https://api.a.com:8080",
  28.       "ServiceHttpMethod": "GET",
  29.       "ServicePath": "/object/add",
  30.       "ServiceTimeout": "2000"
  31.     },
  32.     "SystemParameters": {
  33.       "SystemParameter": [
  34.         {
  35.           "ParameterName": "CaRequestId",
  36.           "ServiceParameterName": "RequestId",
  37.           "Location": "HEAD",
  38.           "DemoValue": "0A964636-F7A3-4F1A-92D7-135584A6397F",
  39.           "Description": "請求編號"
  40.         },
  41.         {
  42.           "ParameterName": "CaAppId",
  43.           "ServiceParameterName": "AppId",
  44.           "Location": "QUERY",
  45.           "DemoValue": "0A964636-F7A3-4F1A-92D7-135584A6398F",
  46.           "Description": "請求者應用編號"
  47.         }
  48.       ]
  49.     },
  50.     "ConstantParameters": {
  51.       "ConstantParameter": {
  52.         "ServiceParameterName": "ConstantKey1",
  53.         "ConstantValue": "helloworld",
  54.         "Location": "QUERY",
  55.         "Description": "Desc"
  56.       }
  57.     },
  58.     "RequestParameters": {
  59.       "RequestParameter": [
  60.         {
  61.           "ApiParameterName": "RequestKey1",
  62.           "Location": "QUERY",
  63.           "ParameterType": "String",
  64.           "Required": "REQUIRED",
  65.           "DemoValue": "demo1",
  66.           "MaxLength": "100",
  67.           "MinLength": "3",
  68.           "DocShow": "PUBLIC",
  69.           "DocOrder": "1",
  70.           "Description": "Desc1"
  71.         },
  72.         {
  73.           "ApiParameterName": "RequestKey2",
  74.           "Location": "QUERY",
  75.           "ParameterType": "Number",
  76.           "Required": "OPTIONAL",
  77.           "DemoValue": "12",
  78.           "MaxValue": "120",
  79.           "MinValue": "100",
  80.           "DocShow": "PUBLIC",
  81.           "DocOrder": "2",
  82.           "Description": "Desc2"
  83.         }
  84.       ]
  85.     },
  86.     "ErrorCodeSamples": {
  87.         "ErrorCodeSample": [
  88.             {
  89.                 "Code": "400",
  90.                 "Message": "Missing the parameter UserId",
  91.                 "Description": "請求缺少參數 UserId"
  92.             }
  93.         ]
  94.     },
  95.     "ServiceParameters": {
  96.       "ServiceParameter": [
  97.         {
  98.           "ServiceParameterName": "ServiceKey1",
  99.           "Location": "QUERY",
  100.           "ParameterType": "String"
  101.         },
  102.         {
  103.           "ServiceParameterName": "ServiceKey2",
  104.           "Location": "QUERY",
  105.           "ParameterType": "Number"
  106.         }
  107.       ]
  108.     },
  109.     "ServiceParametersMap": {
  110.       "ServiceParameterMap": [
  111.         {
  112.           "ServiceParameterName": "RequestKey1",
  113.           "RequestParameterName": "ServiceKey1"
  114.         },
  115.         {
  116.           "ServiceParameterName": "RequestKey2",
  117.           "RequestParameterName": "ServiceKey2"
  118.         }
  119.       ]
  120.     },
  121.     "OpenIdConnectConfig": {
  122.         "publicKey": "EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92",
  123.         "openIdApiType": "IDTOKEN",
  124.         "publicKeyId": "88483727556929326703309904351185815489"
  125.     }
  126. }

最後更新：2016-12-14 17:59:33

  上一篇：go 查詢API列表__API管理相關接口_API_API 網關-阿裏雲
  下一篇：go 查詢API曆史版本列表__API管理相關接口_API_API 網關-阿裏雲