Apis - Get

Mendapatkan detail API yang ditentukan oleh pengidentifikasinya.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2021-12-01-preview

Parameter URI

Name In Required Type Description
apiId
path True
  • string

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ;rev=n sebagai akhiran di mana n adalah nomor revisi.

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True
  • string

Nama grup sumber daya.

serviceName
path True
  • string

Nama layanan API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

Respons

Name Type Description
200 OK

Isi respons berisi entitas API yang ditentukan.

Headers

  • ETag: string
Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

ApiManagementGetApiContract
ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a?api-version=2021-12-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "displayName": "Service",
    "apiRevision": "1",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementGetApiRevisionContract

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2021-12-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Service",
    "apiRevision": "3",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

Definisi

ApiContactInformation

Informasi kontak API

ApiContract

Detail API.

ApiLicenseInformation

Informasi lisensi API

ApiType

Jenis API.

ApiVersionSetContractDetails

Set Versi API berisi konfigurasi umum untuk sekumpulan Versi API yang berkaitan

AuthenticationSettingsContract

Pengaturan Autentikasi API.

ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

OAuth2AuthenticationSettingsContract

Detail pengaturan Autentikasi API OAuth2.

OpenIdAuthenticationSettingsContract

Detail pengaturan Autentikasi API OAuth2.

SubscriptionKeyParameterNamesContract

Detail nama parameter kunci langganan.

ApiContactInformation

Informasi kontak API

Name Type Description
email
  • string

Alamat email kontak/organisasi. HARUS dalam format alamat email

name
  • string

Nama pengidentifikasi kontak/organisasi

url
  • string

URL yang menunjuk ke informasi kontak. HARUS dalam format URL

ApiContract

Detail API.

Name Type Description
id
  • string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nama sumber daya.

properties.apiRevision
  • string

Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat

properties.apiRevisionDescription
  • string

Deskripsi Revisi API.

properties.apiVersion
  • string

Menunjukkan pengidentifikasi versi API jika API diberi versi

properties.apiVersionDescription
  • string

Deskripsi Versi API.

properties.apiVersionSet

Detail set versi

properties.apiVersionSetId
  • string

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.

properties.authenticationSettings

Kumpulan pengaturan autentikasi yang disertakan ke dalam API ini.

properties.contact

Informasi kontak untuk API.

properties.description
  • string

Deskripsi API. Mungkin menyertakan tag pemformatan HTML.

properties.displayName
  • string

Nama API. Panjangnya harus 1 hingga 300 karakter.

properties.isCurrent
  • boolean

Menunjukkan apakah revisi API adalah revisi api saat ini.

properties.isOnline
  • boolean

Menunjukkan apakah revisi API dapat diakses melalui gateway.

properties.license

Informasi lisensi untuk API.

properties.path
  • string

URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL basis titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini.

properties.protocols
  • string[]

Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.

properties.serviceUrl
  • string

URL absolut dari layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.

properties.sourceApiId
  • string

Pengidentifikasi API dari API sumber.

properties.subscriptionKeyParameterNames

Protokol tempat API tersedia.

properties.subscriptionRequired
  • boolean

Menentukan apakah API atau langganan Produk diperlukan untuk mengakses API.

properties.termsOfServiceUrl
  • string

URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.

properties.type

Jenis API.

type
  • string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

ApiLicenseInformation

Informasi lisensi API

Name Type Description
name
  • string

Nama lisensi yang digunakan untuk API

url
  • string

URL ke lisensi yang digunakan untuk API. HARUS dalam format URL

ApiType

Jenis API.

Name Type Description
graphql
  • string
http
  • string
soap
  • string
websocket
  • string

ApiVersionSetContractDetails

Set Versi API berisi konfigurasi umum untuk sekumpulan Versi API yang berkaitan

Name Type Description
description
  • string

Deskripsi Set Versi API.

id
  • string

Pengidentifikasi untuk Set Versi API yang ada. Hilangkan nilai ini untuk membuat Set Versi baru.

name
  • string

Nama tampilan Set Versi API.

versionHeaderName
  • string

Nama parameter header HTTP yang menunjukkan Versi API jika versioningScheme diatur ke header.

versionQueryName
  • string

Nama parameter kueri yang menunjukkan Versi API jika versioningScheme diatur ke query.

versioningScheme enum:
  • Header
  • Query
  • Segment

Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP.

AuthenticationSettingsContract

Pengaturan Autentikasi API.

Name Type Description
oAuth2

Pengaturan Autentikasi OAuth2

openid

Pengaturan Autentikasi Koneksi OpenID

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name Type Description
code
  • string

Kode kesalahan tingkat properti.

message
  • string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target
  • string

Nama properti.

ErrorResponse

Respons Kesalahan.

Name Type Description
error.code
  • string

Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.

error.details

Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.

error.message
  • string

Representasi kesalahan yang dapat dibaca manusia.

OAuth2AuthenticationSettingsContract

Detail pengaturan Autentikasi API OAuth2.

Name Type Description
authorizationServerId
  • string

Pengidentifikasi server otorisasi OAuth.

scope
  • string

cakupan operasi.

OpenIdAuthenticationSettingsContract

Detail pengaturan Autentikasi API OAuth2.

Name Type Description
bearerTokenSendingMethods
  • string[]

Cara mengirim token ke server.

openidProviderId
  • string

Pengidentifikasi server otorisasi OAuth.

SubscriptionKeyParameterNamesContract

Detail nama parameter kunci langganan.

Name Type Description
header
  • string

Nama header kunci langganan.

query
  • string

Nama parameter string kueri kunci langganan.