共用方式為

Api Export - Get

  • 參考
服務:
API Management
API 版本:
2024-05-01

取得其識別碼所指定 API 的詳細數據，格式為記憶體 Blob，且 SAS 金鑰有效 5 分鐘。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?format={format}&export=true&api-version=2024-05-01

URI 參數

名稱 位於 必要 類型 Description
apiId
 path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

資源群組的名稱。 名稱不區分大小寫。
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

API 管理服務的名稱。
subscriptionId
 path True

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version
 query True

string

minLength: 1

要用於這項作業的 API 版本。
export
 query True

ExportApi

匯出 API 詳細資料所需的查詢參數。
format
 query True

ExportFormat

用來將 Api 詳細數據匯出至記憶體 Blob 的格式，Sas 金鑰有效期為 5 分鐘。 未來可以加入新的格式。

回應

名稱 類型 Description
200 OK

ApiExportResult

回應包含具有一組完整 API 元數據的數據流，並包含具有內嵌作業實體陣列的 API 實體。
Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

ApiManagementGetApiExportInOpenApi2dot0
ApiManagementGetApiExportInOpenApi3dot0

ApiManagementGetApiExportInOpenApi2dot0

範例要求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api?format=swagger-link&export=true&api-version=2024-05-01

範例回覆

狀態碼:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
  "format": "swagger-link-json",
  "value": {
    "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?XXXXXXXX"
  }
}

ApiManagementGetApiExportInOpenApi3dot0

範例要求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676?format=openapi-link&export=true&api-version=2024-05-01

範例回覆

狀態碼:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676",
  "format": "openapi-link",
  "value": {
    "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signatureXXXX"
  }
}

定義

名稱 Description
ApiExportResult

API 匯出結果。
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應
ExportApi

匯出 API 詳細資料所需的查詢參數。
ExportFormat

用來將 Api 詳細數據匯出至記憶體 Blob 的格式，Sas 金鑰有效期為 5 分鐘。 未來可以加入新的格式。
ExportResultFormat

API 詳細數據匯出至記憶體 Blob 的格式，Sas 金鑰有效期為 5 分鐘。
Value

定義匯出之 API 詳細資料架構的物件

ApiExportResult

Object

API 匯出結果。

名稱 類型 Description
format

ExportResultFormat

API 詳細數據匯出至記憶體 Blob 的格式，Sas 金鑰有效期為 5 分鐘。
id

string

匯出之 API 的 ResourceId。
value

Value

定義匯出之 API 詳細資料架構的物件

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細數據。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

Object

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

ExportApi

列舉型別

匯出 API 詳細資料所需的查詢參數。

值 Description
true

ExportFormat

列舉型別

用來將 Api 詳細數據匯出至記憶體 Blob 的格式，Sas 金鑰有效期為 5 分鐘。 未來可以加入新的格式。

值 Description
openapi+json-link

將 OpenAPI 3.0 規格中的 API 定義匯出為 JSON 檔至記憶體 Blob。
openapi-link

將 OpenAPI 3.0 規格中的 API 定義匯出為 YAML 檔至記憶體 Blob。
swagger-link

將 OpenAPI 2.0 規格中的 API 定義匯出為 JSON 檔至記憶體 Blob。
wadl-link

將 WADL 架構中的 API 定義匯出至記憶體 Blob。
wsdl-link

將 WSDL 架構中的 API 定義匯出至記憶體 Blob。 只有類型為 soap 的 API 才支援此專案

ExportResultFormat

列舉型別

API 詳細數據匯出至記憶體 Blob 的格式，Sas 金鑰有效期為 5 分鐘。

值 Description
openapi-link

將 OpenAPI 規格 3.0 中的 API 定義匯出至記憶體 Blob。
swagger-link-json

API 定義會以 OpenAPI 規格 2.0 格式匯出至記憶體 Blob。
wadl-link-json

將 WADL 架構中的 API 定義匯出至記憶體 Blob。
wsdl-link+xml

API 定義會在 WSDL 架構中匯出至記憶體 Blob。 只有類型為 soap 的 API 才支援此專案

Value

Object

定義匯出之 API 詳細資料架構的物件

名稱 類型 Description
link

string

連結至包含匯出作業結果的記憶體 Blob。 Blob URI 僅有效 5 分鐘。