SubscriptionUpdateParameters interface
구독 업데이트 세부 정보입니다.
속성
| allow |
추적을 사용할 수 있는지 여부를 결정합니다. |
| display |
구독 이름입니다. |
| expiration |
구독 만료 날짜입니다. 이 설정은 감사 목적으로만 사용되며 구독이 자동으로 만료되지 않습니다.
|
| owner |
사용자 식별자 경로: /users/{userId} |
| primary |
기본 구독 키입니다. |
| scope | /products/{productId} 또는 /api 또는 /apiId}와 같은 범위 |
| secondary |
보조 구독 키입니다. |
| state | 구독 상태입니다. 가능한 상태는 * 활성 - 구독이 활성 상태이고, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 이루어졌지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 - 구독이 만료 날짜에 도달하여 비활성화되었습니다. |
| state |
상태가 '거부됨'으로 변경될 때 관리자가 구독 상태를 변경하는 것을 설명하는 주석입니다. |
속성 세부 정보
allowTracing
추적을 사용할 수 있는지 여부를 결정합니다.
allowTracing?: boolean
속성 값
boolean
displayName
구독 이름입니다.
displayName?: string
속성 값
string
expirationDate
구독 만료 날짜입니다. 이 설정은 감사 목적으로만 사용되며 구독이 자동으로 만료되지 않습니다.
state 속성을 사용하여 구독 수명 주기를 관리할 수 있습니다. 날짜는 ISO 8601 표준에 지정된 yyyy-MM-ddTHH:mm:ssZ 형식을 준수합니다.
expirationDate?: Date
속성 값
Date
ownerId
사용자 식별자 경로: /users/{userId}
ownerId?: string
속성 값
string
primaryKey
기본 구독 키입니다.
primaryKey?: string
속성 값
string
scope
/products/{productId} 또는 /api 또는 /apiId}와 같은 범위
scope?: string
속성 값
string
secondaryKey
보조 구독 키입니다.
secondaryKey?: string
속성 값
string
state
구독 상태입니다. 가능한 상태는 * 활성 - 구독이 활성 상태이고, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 이루어졌지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 - 구독이 만료 날짜에 도달하여 비활성화되었습니다.
state?: SubscriptionState
속성 값
stateComment
상태가 '거부됨'으로 변경될 때 관리자가 구독 상태를 변경하는 것을 설명하는 주석입니다.
stateComment?: string
속성 값
string