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=2022-08-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
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. Nama tidak peka huruf besar/kecil.

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

ID langganan target.

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

Respons

Nama Jenis Deskripsi
200 OK

ApiContract

Isi respons berisi entitas API yang ditentukan.

Headers

ETag: string

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama Deskripsi
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=2022-08-01

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"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "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=2022-08-01

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"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

Definisi

Nama Deskripsi
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.

bearerTokenSendingMethods

Cara mengirim token ke server.

ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

OAuth2AuthenticationSettingsContract

Detail pengaturan Autentikasi API OAuth2.

OpenIdAuthenticationSettingsContract

Detail pengaturan Autentikasi API OAuth2.

Protocol

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

SubscriptionKeyParameterNamesContract

Detail nama parameter kunci langganan.

versioningScheme

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

ApiContactInformation

Informasi kontak API

Nama Jenis Deskripsi
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.

Nama Jenis Deskripsi
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

ApiVersionSetContractDetails

Detail set versi

properties.apiVersionSetId

string

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.

properties.authenticationSettings

AuthenticationSettingsContract

Kumpulan pengaturan autentikasi yang disertakan ke dalam API ini.

properties.contact

ApiContactInformation

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

ApiLicenseInformation

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

Protocol[]

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

SubscriptionKeyParameterNamesContract

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

ApiType

Jenis API.

type

string

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

ApiLicenseInformation

Informasi lisensi API

Nama Jenis Deskripsi
name

string

Nama lisensi yang digunakan untuk API

url

string

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

ApiType

Jenis API.

Nama Jenis Deskripsi
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

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

Nama Jenis Deskripsi
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

versioningScheme

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

AuthenticationSettingsContract

Pengaturan Autentikasi API.

Nama Jenis Deskripsi
oAuth2

OAuth2AuthenticationSettingsContract

Pengaturan Autentikasi OAuth2

oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

Kumpulan pengaturan autentikasi OAuth2 yang disertakan ke dalam API ini.

openid

OpenIdAuthenticationSettingsContract

Pengaturan Autentikasi OpenID Connect

openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

Kumpulan pengaturan autentikasi Open ID Connect yang disertakan ke dalam API ini.

bearerTokenSendingMethods

Cara mengirim token ke server.

Nama Jenis Deskripsi
authorizationHeader

string

Token akses akan dikirimkan di header Otorisasi menggunakan skema Pembawa

query

string

Token akses akan ditransmisikan sebagai parameter kueri.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan tingkat properti.

message

string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target

string

Nama properti.

ErrorResponse

Respons Kesalahan.

Nama Jenis Deskripsi
error.code

string

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

error.details

ErrorFieldContract[]

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.

Nama Jenis Deskripsi
authorizationServerId

string

Pengidentifikasi server otorisasi OAuth.

scope

string

cakupan operasi.

OpenIdAuthenticationSettingsContract

Detail pengaturan Autentikasi API OAuth2.

Nama Jenis Deskripsi
bearerTokenSendingMethods

bearerTokenSendingMethods[]

Cara mengirim token ke server.

openidProviderId

string

Pengidentifikasi server otorisasi OAuth.

Protocol

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

Nama Jenis Deskripsi
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

Detail nama parameter kunci langganan.

Nama Jenis Deskripsi
header

string

Nama header kunci langganan.

query

string

Nama parameter string kueri kunci langganan.

versioningScheme

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

Nama Jenis Deskripsi
Header

string

Versi API diteruskan di header HTTP.

Query

string

Versi API diteruskan dalam parameter kueri.

Segment

string

Versi API diteruskan di segmen jalur.