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

查詢API詳情__API管理相關接口_API_API 網關-阿裏雲

查詢API定義（DescribeApi）

描述

查詢API定義

  • 此接口麵向開放API的用戶
  • 用於查詢指定API的定義

請求參數

名稱 類型 是否必須 描述
Action String 是 操作接口名，係統規定參數，取值：DescribeApi
GroupId String 是 API所在的分組編號
ApiId String 是 API的Id標識

返回參數

名稱 類型 描述
RequestId String 本次創建API的請求Id
RegionId String API所處的Region的Id
ApiId String API的Id標識
ApiName String API的名稱，組內不允許重複
GroupId String API所在的分組編號
GroupName String API所在的分組名稱
Visibility String API是否公開，目前可以取值：
  • PUBLIC：公開，如選擇此類型，該API的線上環境，會在所有用戶的控製台“發現API”頁麵展示
  • PRIVATE：不公開，如選擇此類型，當該組API在雲市場上架時，私有類型的API不會上架
AuthType String API安全認證類型，目前可以取值：
  • APP：隻允許已授權的APP調用
  • ANONYMOUS：允許匿名調用，設置為允許匿名調用需要注意：
    • 任何能夠獲取該API服務信息的人，都將能夠調用該API。網關不會對調用者做身份認證，也無法設置按用戶的流量控製，若開放該API請設置好按API的流量控製。
    • “ANONYMOUS”API不建議上架雲市場，網關無法對調用者區分計量，也無法限製調用次數，若所在分組要上架雲市場，建議將該API轉移至其他分組，或將類型設置為“私有”，或選擇“阿裏雲APP”認證方式。
  • APPOPENID：支持第三方賬號認證OpenID Connect，而且隻允許已授權的APP調用；當設置此項時，參數OpenIdConnectConfig為必傳。
ResultType String 後端服務返回應答的格式，目前可以設置為：JSON、TEXT、BINARY、XML、HTML
ResultSample String 後端服務返回應答的示例
FailResultSample String 後端服務失敗返回應答的示例
CreateTime String API創建的時間
ModifyTime String API最後一次修改的時間
Description String API描述信息
ErrorCodeSamples ErrorCodeSample 後端服務返回的錯誤碼示例，詳情見ApiAttributesType.md#ErrorCodeSamples
SystemParameters SystemParameter 網關發送給後端服務的係統參數，詳情見ApiAttributesType.md#SystemParameters
ConstantParameters ConstantParameter 網關發送給後端服務的常量參數，詳情見ApiAttributesType.md#ConstantParameters
RequestParametersObject RequestParameter Consumer向網關發送API請求的參數描述，詳情見ApiAttributesType.md#RequestParameters
ServiceParametersObject ServiceParameter 網關向後端服務發送API請求的參數描述，詳情見ApiAttributesType.md#ServiceParameters
ParametersMapObject ServiceParameterMap Consumer向網關發送請求的參數和網關向後端服務發送的請求的參數的映射關係，詳情見ApiAttributesType.md#ServiceParametersMap
DeployedInfos DeployedInfo API發布狀態，詳情見ApiAttributesType.md#DeployedInfos
RequestConfig RequestConfig Consumer向網關發送API請求的相關配置項，詳情見ApiAttributesType.md#RequestConfig
ServiceConfig ServiceConfig 網關向後端服務發送API請求的相關配置項，詳情見ApiAttributesType.md#ServiceConfig
OpenIdConnectConfig OpenIdConnectConfig 第三方賬號認證OpenID Connect相關配置項，詳情見ApiAttributesType.md#OpenIdConnectConfig

示例

請求示例

  1. https://ecs.aliyuncs.com/?Action=DescribeApi
  2. &GroupId=08ae4aa0f95e4321849ee57f4e0b3077
  3. &ApiId=8afff6c8c4c6447abb035812e4d66b65
  5. &<公共請求參數>

返回示例

XML格式

  1. <DescribeApiResponse>
  2.     <RequestId>D0FF585F-7966-40CF-BC60-75DB070B23D5</RequestId>
  3.     <RegionId>cn-qingdao</RegionId>
  4.     <Description>Api description</Description>
  5.     <ApiName>ApiName</ApiName>
  6.     <CreatedTime>2016-07-28T09:50:43Z</CreatedTime>
  7.     <GroupName>ApiTest</GroupName>
  8.     <ModifiedTime>2016-07-28T13:13:12Z</ModifiedTime>
  9.     <ServiceParametersObject>
  10.         <ServiceParam>
  11.             <ServiceParameterName>age</ServiceParameterName>
  12.             <Type>Number</Type>
  13.             <Location>head</Location>
  14.         </ServiceParam>
  15.         <ServiceParam>
  16.             <ServiceParameterName>sex</ServiceParameterName>
  17.             <Type>String</Type>
  18.             <Location>query</Location>
  19.         </ServiceParam>
  20.         <ServiceParam>
  21.             <ServiceParameterName>userId</ServiceParameterName>
  22.             <Type>Number</Type>
  23.             <Location>path</Location>
  24.         </ServiceParam>
  25.         <ServiceParam>
  26.             <ServiceParameterName>clientIp</ServiceParameterName>
  27.             <Type>String</Type>
  28.             <Location>head</Location>
  29.         </ServiceParam>
  30.         <ServiceParam>
  31.             <ServiceParameterName>constance</ServiceParameterName>
  32.             <Type>String</Type>
  33.             <Location>head</Location>
  34.         </ServiceParam>
  35.     </ServiceParametersObject>
  36.     <ConstantParameters>
  37.         <ConstantParameter>
  38.             <ServiceParameterName>constance</ServiceParameterName>
  39.             <Description>constance</Description>
  40.             <Location>HEAD</Location>
  41.             <ConstantValue>constance</ConstantValue>
  42.         </ConstantParameter>
  43.     </ConstantParameters>
  44.     <GroupId>08ae4aa0f95e4321849ee57f4e0b3077</GroupId>
  45.     <SystemParameters>
  46.         <SystemParameter>
  47.             <ServiceParameterName>clientIp</ServiceParameterName>
  48.             <Description>客戶端IP</Description>
  49.             <DemoValue>192.168.1.1</DemoValue>
  50.             <Location>HEAD</Location>
  51.             <ParameterName>CaClientIp</ParameterName>
  52.         </SystemParameter>
  53.     </SystemParameters>
  54.     <RequestParametersObject>
  55.         <RequestParam>
  56.             <Required>OPTIONAL</Required>
  57.             <MinValue>18</MinValue>
  58.             <Description>年齡</Description>
  59.             <DemoValue>20</DemoValue>
  60.             <ParameterType>NUMBER</ParameterType>
  61.             <ApiParameterName>age</ApiParameterName>
  62.             <DocShow>PUBLIC</DocShow>
  63.             <DefaultValue>20</DefaultValue>
  64.             <Location>HEAD</Location>
  65.             <MaxValue>100</MaxValue>
  66.             <DocOrder>0</DocOrder>
  67.         </RequestParam>
  68.         <RequestParam>
  69.             <Required>OPTIONAL</Required>
  70.             <Description>性別</Description>
  71.             <DemoValue>boy</DemoValue>
  72.             <ParameterType>STRING</ParameterType>
  73.             <ApiParameterName>sex</ApiParameterName>
  74.             <DocShow>PUBLIC</DocShow>
  75.             <DefaultValue>boy</DefaultValue>
  76.             <Location>QUERY</Location>
  77.             <EnumValue>boy,girl</EnumValue>
  78.             <DocOrder>0</DocOrder>
  79.         </RequestParam>
  80.         <RequestParam>
  81.             <Required>REQUIRED</Required>
  82.             <MinValue>10000000</MinValue>
  83.             <ParameterType>NUMBER</ParameterType>
  84.             <ApiParameterName>userId</ApiParameterName>
  85.             <DocShow>PUBLIC</DocShow>
  86.             <Location>PATH</Location>
  87.             <MaxValue>100000000</MaxValue>
  88.             <DocOrder>0</DocOrder>
  89.         </RequestParam>
  90.     </RequestParametersObject>
  91.     <DeployedInfos>
  92.         <DeployedInfo>
  93.             <DeployedStatus>NONDEPLOYED</DeployedStatus>
  94.             <StageName>TEST</StageName>
  95.         </DeployedInfo>
  96.         <DeployedInfo>
  97.             <DeployedStatus>NONDEPLOYED</DeployedStatus>
  98.             <StageName>RELEASE</StageName>
  99.         </DeployedInfo>
  100.     </DeployedInfos>
  101.     <ServiceConfig>
  102.         <ServiceProtocol>HTTP</ServiceProtocol>
  103.         <ServiceTimeout>1000</ServiceTimeout>
  104.         <ServiceAddress>https://www.customerdomain.com</ServiceAddress>
  105.         <ServicePath>/v3/getUserTest/[userId]</ServicePath>
  106.         <ServiceHttpMethod>GET</ServiceHttpMethod>
  107.         <Mock>FALSE</Mock>
  108.     </ServiceConfig>
  109.     <RequestId>D0FF585F-7966-40CF-BC60-75DB070B23D5</RequestId>
  110.     <RegionId>cn-qingdao</RegionId>
  111.     <RequestConfig>
  112.         <RequestHttpMethod>GET</RequestHttpMethod>
  113.         <RequestProtocol>HTTP</RequestProtocol>
  114.         <RequestPath>/v3/getUserTest/[userId]</RequestPath>
  115.     </RequestConfig>
  116.     <Visibility>PUBLIC</Visibility>
  117.     <ParametersMapObject>
  118.         <ServiceParameterMap>
  119.             <ServiceParameterName>sex</ServiceParameterName>
  120.             <RequestParameterName>sex</RequestParameterName>
  121.         </ServiceParameterMap>
  122.         <ServiceParameterMap>
  123.             <ServiceParameterName>age</ServiceParameterName>
  124.             <RequestParameterName>age</RequestParameterName>
  125.         </ServiceParameterMap>
  126.         <ServiceParameterMap>
  127.             <ServiceParameterName>userId</ServiceParameterName>
  128.             <RequestParameterName>userId</RequestParameterName>
  129.         </ServiceParameterMap>
  130.     </ParametersMapObject>
  131.     <ErrorCodeSamples>
  132.         <ErrorCodeSample>
  133.             <Code>400</Code>
  134.             <Message>Missing the parameter UserId</Message>
  135.             <Description>請求缺少參數 UserId</Description>
  136.         </ErrorCodeSample>
  137.     </ErrorCodeSamples>
  138.     <ApiId>8afff6c8c4c6447abb035812e4d66b65</ApiId>
  139.     <AuthType>APP</AuthType>
  140.     <ResultType>HTML</ResultType>
  141.     <ResultSample>200</ResultSample>
  142.     <FailResultSample>400</FailResultSample>
  143.     <OpenIdConnectConfig>
  144.         <publicKey>EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92</publicKey>
  145.         <openIdApiType>IDTOKEN</openIdApiType>
  146.         <publicKeyId>88483727556929326703309904351185815489</publicKeyId>
  147.     </OpenIdConnectConfig>    
  148. </DescribeApiResponse>

JSON格式

  1. {
  2.     "RequestId":D0FF585F-7966-40CF-BC60-75DB070B23D5,
  3.     "RegionId":cn-qingdao,
  4.     "Description": "billingTest001",
  5.     "ApiName": "billingTest001",
  6.     "CreatedTime": "2016-07-01T09:18:20Z",
  7.     "GroupName": "billingTest",
  8.     "ModifiedTime": "2016-07-21T03:52:12Z",
  9.     "ServiceParametersObject": {
  10.         "ServiceParam": [
  11.             {
  12.                 "ServiceParameterName": "headerParam",
  13.                 "Type": "String",
  14.                 "Location": "head"
  15.             },
  16.             {
  17.                 "ServiceParameterName": "queryparam",
  18.                 "Type": "String",
  19.                 "Location": "query"
  20.             },
  21.             {
  22.                 "ServiceParameterName": "NumberParam",
  23.                 "Type": "Number",
  24.                 "Location": "query"
  25.             },
  26.             {
  27.                 "ServiceParameterName": "type",
  28.                 "Type": "String",
  29.                 "Location": "path"
  30.             },
  31.             {
  32.                 "ServiceParameterName": "clientIp",
  33.                 "Type": "String",
  34.                 "Location": "head"
  35.             },
  36.             {
  37.                 "ServiceParameterName": "constantParam",
  38.                 "Type": "String",
  39.                 "Location": "query"
  40.             }
  41.         ]
  42.     },
  43.     "ConstantParameters": {
  44.         "ConstantParameter": [
  45.             {
  46.                 "ServiceParameterName": "constantParam",
  47.                 "Description": "constant",
  48.                 "Location": "QUERY",
  49.                 "ConstantValue": "constant"
  50.             }
  51.         ]
  52.     },
  53.     "GroupId": "4a3f3050b9c5469bb685bdd29e571be1",
  54.     "SystemParameters": {
  55.         "SystemParameter": [
  56.             {
  57.                 "ServiceParameterName": "clientIp",
  58.                 "Description": "客戶端IP",
  59.                 "DemoValue": "192.168.1.1",
  60.                 "Location": "HEAD",
  61.                 "ParameterName": "CaClientIp"
  62.             }
  63.         ]
  64.     },
  65.     "RequestParametersObject": {
  66.         "RequestParam": [
  67.             {
  68.                 "Required": "OPTIONAL",
  69.                 "Description": "head param",
  70.                 "DemoValue": "headparm",
  71.                 "ParameterType": "STRING",
  72.                 "ApiParameterName": "headerParam",
  73.                 "DocShow": "PUBLIC",
  74.                 "DefaultValue": "",
  75.                 "Location": "HEAD",
  76.                 "EnumValue": "head",
  77.                 "DocOrder": 0
  78.             },
  79.             {
  80.                 "Required": "REQUIRED",
  81.                 "ParameterType": "STRING",
  82.                 "ApiParameterName": "queryparam",
  83.                 "DocShow": "PUBLIC",
  84.                 "DefaultValue": "",
  85.                 "Location": "QUERY",
  86.                 "DocOrder": 0
  87.             },
  88.             {
  89.                 "Required": "OPTIONAL",
  90.                 "MinValue": 1,
  91.                 "Description": "number param",
  92.                 "DemoValue": "10",
  93.                 "ParameterType": "NUMBER",
  94.                 "ApiParameterName": "NumberParam",
  95.                 "DocShow": "PUBLIC",
  96.                 "DefaultValue": "10",
  97.                 "Location": "QUERY",
  98.                 "MaxValue": 100,
  99.                 "DocOrder": 0
  100.             },
  101.             {
  102.                 "Required": "REQUIRED",
  103.                 "ParameterType": "STRING",
  104.                 "ApiParameterName": "type",
  105.                 "DocShow": "PUBLIC",
  106.                 "Location": "PATH",
  107.                 "DocOrder": 0
  108.             }
  109.         ]
  110.     },
  111.     "DeployedInfos": {
  112.         "DeployedInfo": [
  113.             {
  114.                 "DeployedStatus": "NONDEPLOYED",
  115.                 "StageName": "TEST"
  116.             },
  117.             {
  118.                 "DeployedStatus": "DEPLOYED",
  119.                 "StageName": "RELEASE",
  120.                 "EffectiveVersion": "20160721115223375"
  121.             }
  122.         ]
  123.     },
  124.     "ServiceConfig": {
  125.         "ServiceProtocol": "HTTP",
  126.         "ServiceTimeout": 10000,
  127.         "ServiceAddress": "https://120.55.69.157:8080",
  128.         "ServicePath": "/web/cloudapi/[type]",
  129.         "ServiceHttpMethod": "POST",
  130.         "Mock": "CLOSED"
  131.     },
  132.     "RequestId": "415F037A-94C2-4100-B17A-F3C514CA1391",
  133.     "RegionId": "cn-qingdao",
  134.     "RequestConfig": {
  135.         "RequestHttpMethod": "POST",
  136.         "RequestProtocol": "HTTP",
  137.         "PostBodyDescription": "fwefwef",
  138.         "BodyFormat": "STREAM",
  139.         "RequestPath": "/api/billing/test/[type]"
  140.     },
  141.     "Visibility": "PUBLIC",
  142.     "ParametersMapObject": {
  143.         "ServiceParameterMap": [
  144.             {
  145.                 "ServiceParameterName": "headerParam",
  146.                 "RequestParameterName": "headerParam"
  147.             },
  148.             {
  149.                 "ServiceParameterName": "queryparam",
  150.                 "RequestParameterName": "queryparam"
  151.             },
  152.             {
  153.                 "ServiceParameterName": "NumberParam",
  154.                 "RequestParameterName": "NumberParam"
  155.             },
  156.             {
  157.                 "ServiceParameterName": "type",
  158.                 "RequestParameterName": "type"
  159.             }
  160.         ]
  161.     },
  162.     "ErrorCodeSamples": {
  163.         "ErrorCodeSample": [
  164.             {
  165.                 "Code": "400",
  166.                 "Message": "Missing the parameter UserId",
  167.                 "Description": "請求缺少參數 UserId"
  168.             }
  169.         ]
  170.     },
  171.     "ApiId": "e77fd9257b1d436a806fe23c649300a0",
  172.     "AuthType": "APP",
  173.     "ResultType": "JSON",
  174.     "ResultSample": "fwef",
  175.     "FailResultSample": "400",
  176.     "OpenIdConnectConfig": {
  177.         "publicKey": "EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92",
  178.         "openIdApiType": "IDTOKEN",
  179.         "publicKeyId": "88483727556929326703309904351185815489"
  180.     }
  181. }

最後更新：2016-12-14 17:46:49

  上一篇：go 刪除API__API管理相關接口_API_API 網關-阿裏雲
  下一篇：go 查詢API服務文檔__API管理相關接口_API_API 網關-阿裏雲