Pobieranie niestandardowych dat zakończenia terminu
Dotyczy: Centrum partnerskie | Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA
Partnerzy mogą wyświetlać dozwolone niestandardowe daty zakończenia terminów dla subskrypcji opartych na licencjach usługi NCE, które kupują dla swoich klientów. Partnerzy mogą wyświetlać daty zakończenia zgodne z końcem miesiąca kalendarzowego lub współterminą z istniejącymi subskrypcjami klientów.
Interfejsy API obsługują tylko obliczanie niestandardowych dat zakończenia terminów zakupu nowych subskrypcji, a nie na potrzeby odnawiania istniejących subskrypcji.
Wymagania wstępne
Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie zarówno przy użyciu autonomicznych poświadczeń aplikacji, jak i aplikacji i użytkownika.
A CustomerTenantId. Jeśli nie znasz identyfikatora klienta, możesz wyszukać go w Centrum partnerskim, wybierając obszar roboczy Klienci , a następnie klienta z listy klienta, a następnie pozycję Konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta. Identyfikator Microsoft jest taki sam jak identyfikator klienta.
Żądanie REST
Składnia żądania
Method | Identyfikator URI żądania |
---|---|
GET | {baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates |
Ciągi zapytania
W tej tabeli wymieniono ciągi zapytania potrzebne do filtrowania i pobierania niestandardowych dat zakończenia terminów.
Imię i nazwisko: | Wymagana liczba rdzeni: | Opis rozwiązania: |
---|---|---|
term_duration | Tak | Reprezentacja iso 8601 czasu trwania terminu. Bieżące obsługiwane wartości to P1M (1 miesiąc), P1Y (1 rok) i P3Y (3 lata). |
term_start_date | Nie. | Planowana data zakupu. Nie może to być w przeszłości. |
target_coterm_subscription_id | Nie. | Ciąg sformatowany za pomocą identyfikatora GUID, który identyfikuje subskrypcję do wspólnej subskrypcji. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego. Odpowiedź interfejsu API zwraca maksymalnie 300 rekordów stron. Jeśli w zapytaniu wejściowym zostanie zwróconych ponad 300 rekordów, w nagłówku odpowiedzi zostanie podany token kontynuacji. Token kontynuacji może być wejściowy w nagłówku następującego żądania, aby zwrócić dodatkowe rekordy stron, których dotyczy zapytanie.
Treść żądania
Brak.
Odpowiedź REST
Jeśli ta metoda powiedzie się, zwraca szczegóły subskrypcji , które zostały zmigrowane (obiekt migracji) w treści odpowiedzi. Obejmuje to identyfikator migracji.
Kody powodzenia i błędów odpowiedzi
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i dodatkowe informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i dodatkowe parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.
Przykłady adresów URL żądań
baseurl/v1/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M
Przykłady odpowiedzi
{
"totalCount": 2,
"items": [
{
"allowedCustomTermEndDateType": "calendarMonthAligned",
"allowedCustomTermEndDate": "2023-07-31T00:00:00"
},
{
"allowedCustomTermEndDateType": "subscriptionAligned",
"cotermSubscriptionIds": [
"5fcf618b-1daa-4604-da99-cc3e1c9ee422",
"d30a9ff9-713e-4546-c97e-f06b9dcf6ef6"
],
"allowedCustomTermEndDate": "2023-08-01T00:00:00"
}
],
"links": {
"self": {
"uri": "/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}