다음을 통해 공유


Gateway - List Keys

게이트웨이 키를 검색합니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2021-08-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
gatewayId
path True

string

게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.

resourceGroupName
path True

string

리소스 그룹의 이름.

serviceName
path True

string

API Management 서비스의 이름입니다.

regex 패턴: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.

api-version
query True

string

클라이언트 요청과 함께 사용할 API의 버전입니다.

응답

Name 형식 Description
200 OK

GatewayKeysContract

응답 본문에는 지정된 게이트웨이 키가 포함됩니다.

헤더

ETag: string

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementGatewayListKeys

샘플 요청

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2021-08-01

샘플 응답

{
  "primary": "primary_key_value",
  "secondary": "secondary_key_value"
}

정의

Name Description
ErrorFieldContract

오류 필드 계약.

ErrorResponse

오류 응답.

GatewayKeysContract

게이트웨이 인증 키.

ErrorFieldContract

오류 필드 계약.

Name 형식 Description
code

string

속성 수준 오류 코드입니다.

message

string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.

target

string

속성 이름입니다.

ErrorResponse

오류 응답.

Name 형식 Description
error.code

string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.

error.details

ErrorFieldContract[]

유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다.

error.message

string

사람이 읽을 수 있는 오류 표현입니다.

GatewayKeysContract

게이트웨이 인증 키.

Name 형식 Description
primary

string

기본 게이트웨이 키입니다.

secondary

string

보조 게이트웨이 키.