Действие GetEndpointAttributes
Получает атрибуты эндпоинта для Push-уведомлений.
HTTP-запрос
POST https://notifications.yandexcloud.net/
Query-параметры
| Параметр | Описание |
|---|---|
Action |
string Обязательное поле. Параметр для обозначения типа операции. Значение: GetEndpointAttributes. |
EndpointArn |
string Обязательное поле. Идентификатор (ARN) мобильного эндпоинта. Пример: arn:aws:sns::aoegtvhtp8ob********:endpoint/GCM/test-cns-9990/4cbe148515360244248c993abe0a12884d162bb15e87d6c16bd0c810********. |
ResponseFormat |
string Формат ответа. Возможные значения:
|
Ответ
Успешный ответ
При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.
Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.
Схема данных:
<?xml version="1.0" encoding="UTF-8"?>
<GetEndpointAttributesResponse>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
<CustomUserData>string</CustomUserData>
<Enabled>true</Enabled>
</GetEndpointAttributesResponse>
{
"ResponseMetadata": {
"RequestId": "string"
},
"CustomUserData": "string",
"Enabled": true
}
Где:
-
RequestId— идентификатор запроса. -
CustomUserData— прочие пользовательские данные, которые хранятся вместе с эндпоинтом. Cloud Notification Service никак не использует эти данные. -
Enabled— атрибут для включение и выключение уведомлений в эндпоинт, в настоящее время не поддерживается. Всегда возвращается значениеtrue.Примечание
Вывод атрибута
Tokenне осуществляется для дополнительной защиты данных.
Ответ с ошибкой
При возникновении ошибки Cloud Notification Service отвечает сообщением с соответствующим HTTP-кодом.
Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.