GetEndpointAttributes
Gets attributes of the endpoint for push notifications.
HTTP request
POST https://notifications.yandexcloud.net/
Query parameters
Parameter | Description |
---|---|
Action |
string Required field. Operation type parameter. Value: GetEndpointAttributes . |
EndpointArn |
string Required field. Endpoint ID (ARN). Example: arn:aws:sns::aoegtvhtp8ob********:endpoint/GCM/test-cns-9990/4cbe148515360244248c993abe0a12884d162bb15e87d6c16bd0c810******** . |
ResponseFormat |
string Response format. The possible values are:
|
Response
Successful response
If there are no errors, Cloud Notification Service returns the 200
HTTP code.
A successful response contains additional data in XML or JSON format depending on the specified ResponseFormat
parameter.
Data schema:
<?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
}
Where:
-
RequestId
: Request ID. -
CustomUserData
: Other user data stored together with the endpoint. Cloud Notification Service does not use this data in any way. -
Enabled
: Attribute for enabling and disabling endpoint notifications, currently not supported. It always returnstrue
.Note
For data protection purposes, you can not output the
Token
attribute.
Error response
In case of an error, Cloud Notification Service returns a message with the appropriate HTTP code.
For a list of common error codes for all actions, see Errors.