다음을 통해 공유


Quota By Period Keys - Get

서비스 instance 특정 기간 동안 정책의 카운터 키와 연결된 할당량 카운터의 값을 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}?api-version=2021-08-01

URI 매개 변수

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

string

할당량 카운터 키 식별자입니다. 이는 할당량 기준 정책의 카운터 키 특성에 정의된 식의 결과입니다. 예를 들어 정책에서 counter-key="boo"를 지정하면 "boo" 카운터 키로 액세스할 수 있습니다. 그러나 counter-key="@("b"+"a")"로 정의된 경우 "ba" 키로 액세스할 수 있습니다.

quotaPeriodKey
path True

string

할당량 기간 키 식별자입니다.

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

QuotaCounterContract

응답 본문에는 지정된 기간의 할당량 카운터 세부 정보가 포함됩니다.

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 사용자 계정 가장

예제

ApiManagementGetQuotaCounterKeysByQuotaPeriod

샘플 요청

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba/periods/0_P3Y6M4DT12H30M5S?api-version=2021-08-01

샘플 응답

{
  "counterKey": "ba",
  "periodKey": "0_P3Y6M4DT12H30M5S",
  "periodStartTime": "2014-08-04T04:24:35Z",
  "periodEndTime": "2018-02-08T16:54:40Z",
  "value": {
    "callsCount": 0,
    "kbTransferred": 2.5625
  }
}

정의

Name Description
ErrorFieldContract

오류 필드 계약.

ErrorResponse

오류 응답.

QuotaCounterContract

할당량 카운터 세부 정보입니다.

QuotaCounterValueContractProperties

할당량 카운터 값 세부 정보입니다.

ErrorFieldContract

오류 필드 계약.

Name 형식 Description
code

string

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

message

string

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

target

string

속성 이름입니다.

ErrorResponse

오류 응답.

Name 형식 Description
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

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

QuotaCounterContract

할당량 카운터 세부 정보입니다.

Name 형식 Description
counterKey

string

카운터의 키 값입니다. 비어 있지 않아야 합니다.

periodEndTime

string

카운터 기간 종료 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.

periodKey

string

카운터가 수집된 기간의 식별자입니다. 비어 있지 않아야 합니다.

periodStartTime

string

카운터 기간 시작 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.

value

QuotaCounterValueContractProperties

할당량 값 속성

QuotaCounterValueContractProperties

할당량 카운터 값 세부 정보입니다.

Name 형식 Description
callsCount

integer

Counter가 호출된 횟수입니다.

kbTransferred

number

킬로바이트 단위로 전송된 데이터입니다.