次の方法で共有

Api Export - Get

  • リファレンス
サービス:
API Management
API バージョン:
2024-05-01

SAS キーが 5 分間有効なストレージ BLOB に指定された形式で、識別子によって指定された API の詳細を取得します。

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 パラメーター

名前 / 必須 型 説明
apiId
 path True

string

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

API リビジョン識別子。 現在の API Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、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 Management サービスの名前。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。
export
 query True

ExportApi

API の詳細をエクスポートするために必要なクエリ パラメーター。
format
 query True

ExportFormat

SAS キーが 5 分間有効なストレージ BLOB に API の詳細をエクスポートする形式。 新しい形式は、今後追加される可能性があります。

応答

名前 型 説明
200 OK

ApiExportResult

応答には、API メタデータの完全なセットを含むストリームが含まれており、操作エンティティの配列が埋め込まれた API エンティティが含まれます。
Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
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"
  }
}

定義

名前 説明
ApiExportResult

API エクスポートの結果。
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
ExportApi

API の詳細をエクスポートするために必要なクエリ パラメーター。
ExportFormat

SAS キーが 5 分間有効なストレージ BLOB に API の詳細をエクスポートする形式。 新しい形式は、今後追加される可能性があります。
ExportResultFormat

SAS キーを使用して 5 分間有効なストレージ BLOB に API の詳細がエクスポートされる形式。
Value

エクスポートされた API Detail のスキーマを定義するオブジェクト

ApiExportResult

Object

API エクスポートの結果。

名前 型 説明
format

ExportResultFormat

SAS キーを使用して 5 分間有効なストレージ BLOB に API の詳細がエクスポートされる形式。
id

string

エクスポートされた API の ResourceId。
value

Value

エクスポートされた API Detail のスキーマを定義するオブジェクト

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

ExportApi

列挙

API の詳細をエクスポートするために必要なクエリ パラメーター。

値 説明
true

ExportFormat

列挙

SAS キーが 5 分間有効なストレージ BLOB に API の詳細をエクスポートする形式。 新しい形式は、今後追加される可能性があります。

値 説明
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 にエクスポートします。 これは、type soap の API でのみサポートされます

ExportResultFormat

列挙

SAS キーを使用して 5 分間有効なストレージ BLOB に API の詳細がエクスポートされる形式。

値 説明
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 にエクスポートされます。 これは、type soap の API でのみサポートされます

Value

Object

エクスポートされた API Detail のスキーマを定義するオブジェクト

名前 型 説明
link

string

エクスポート操作の結果を含むストレージ BLOB へのリンク。 BLOB URI は 5 分間のみ有効です。