SubscriptionCreateParameters interface
Szczegóły tworzenia subskrypcji.
Właściwości
allow |
Określa, czy śledzenie można włączyć |
display |
Nazwa subskrypcji. |
owner |
Użytkownik (ścieżka identyfikatora użytkownika), dla którego subskrypcja jest tworzona w postaci /users/{userId} |
primary |
Podstawowy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie. |
scope | Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}. |
secondary |
Pomocniczy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie. |
state | Stan początkowej subskrypcji. Jeśli żadna wartość nie zostanie określona, subskrypcja zostanie utworzona ze stanem Przesłano. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało złożone przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasła — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana. |
Szczegóły właściwości
allowTracing
Określa, czy śledzenie można włączyć
allowTracing?: boolean
Wartość właściwości
boolean
displayName
Nazwa subskrypcji.
displayName?: string
Wartość właściwości
string
ownerId
Użytkownik (ścieżka identyfikatora użytkownika), dla którego subskrypcja jest tworzona w postaci /users/{userId}
ownerId?: string
Wartość właściwości
string
primaryKey
Podstawowy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie.
primaryKey?: string
Wartość właściwości
string
scope
Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}.
scope?: string
Wartość właściwości
string
secondaryKey
Pomocniczy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie.
secondaryKey?: string
Wartość właściwości
string
state
Stan początkowej subskrypcji. Jeśli żadna wartość nie zostanie określona, subskrypcja zostanie utworzona ze stanem Przesłano. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało złożone przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasła — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana.
state?: SubscriptionState