你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Workspace Api Export - Get

获取由标识符指定的 API 的详细信息,其格式为存储 Blob,SAS 密钥有效期为 5 分钟。

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

URI 参数

名称 必需 类型 说明
apiId
path True

string

API 修订标识符。 在当前 API 管理服务实例中必须是唯一的。 非当前修订版具有 ;rev=n 作为后缀,其中 n 是修订号。

正则表达式模式: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

uuid

目标订阅的 ID。 该值必须是 UUID。

workspaceId
path True

string

工作区标识符。 在当前 API 管理服务实例中必须是唯一的。

正则表达式模式: ^[^*#&+:<>?]+$

api-version
query True

string

要用于此操作的 API 版本。

export
query True

ExportApi

导出 API 详细信息所需的查询参数。

format
query True

ExportFormat

将 Api 详细信息导出到存储 Blob 的格式,Sas 密钥有效期为 5 分钟。

响应

名称 类型 说明
200 OK

ApiExportResult

响应包含一个包含完整 API 元数据集的流,并包含具有嵌入的操作实体数组的 API 实体。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGetWorkspaceApiExportInOpenApi2dot0
ApiManagementGetWorkspaceApiExportInOpenApi3dot0

ApiManagementGetWorkspaceApiExportInOpenApi2dot0

示例请求

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

示例响应

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
  "format": "swagger-link-json",
  "value": {
    "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?storage-sas-signature"
  }
}

ApiManagementGetWorkspaceApiExportInOpenApi3dot0

示例请求

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

示例响应

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

定义

名称 说明
ApiExportResult

API 导出结果。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ExportApi

导出 API 详细信息所需的查询参数。

ExportFormat

将 Api 详细信息导出到存储 Blob 的格式,Sas 密钥有效期为 5 分钟。

ExportResultFormat

将 API 详细信息导出到存储 Blob 的格式,Sas 密钥有效期为 5 分钟。

Value

资源的集合。

ApiExportResult

API 导出结果。

名称 类型 说明
format

ExportResultFormat

将 API 详细信息导出到存储 Blob 的格式,Sas 密钥有效期为 5 分钟。

id

string

导出的 API 的 ResourceId。

value

Value

定义导出的 API 详细信息的架构的对象

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ExportApi

导出 API 详细信息所需的查询参数。

名称 类型 说明
true

string

ExportFormat

将 Api 详细信息导出到存储 Blob 的格式,Sas 密钥有效期为 5 分钟。

名称 类型 说明
openapi+json-link

string

将 OpenAPI 3.0 规范中的 Api 定义作为 JSON 文档导出到存储 Blob。

openapi-link

string

将 OpenAPI 3.0 规范中的 Api 定义作为 YAML 文档导出到存储 Blob。

swagger-link

string

将 OpenAPI 2.0 规范中的 Api 定义作为 JSON 文档导出到存储 Blob。

wadl-link

string

将 WADL 架构中的 Api 定义导出到存储 Blob。

wsdl-link

string

将 WSDL 架构中的 Api 定义导出到存储 Blob。 仅类型为 的 API 支持此操作 soap

ExportResultFormat

将 API 详细信息导出到存储 Blob 的格式,Sas 密钥有效期为 5 分钟。

名称 类型 说明
openapi-link

string

将 OpenAPI 规范 3.0 中的 API 定义导出到存储 Blob。

swagger-link-json

string

API 定义以 OpenAPI 规范 2.0 格式导出到存储 Blob。

wadl-link-json

string

将 WADL 架构中的 API 定义导出到存储 Blob。

wsdl-link+xml

string

API 定义在 WSDL 架构中导出到存储 Blob。 仅类型为 的 API 支持此操作 soap

Value

资源的集合。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”