Call the DescribeSubscriptions operation to query the list of event notification subscriptions.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.

Action string required Sample value: DescribeSubscriptions

The action that you want to perform. Value: DescribeSubscriptions.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

MaxResults integer Optional Sample value: 20

The number of entries returned on each page in a pagination query.

Default value: 20

Maximum value: 100

Minimum value: 0

NextToken string Optional Sample value: --

Pagination token marking the query position. Omit this parameter for initial API requests. In the next query, set the NextToken parameter to the value returned by the previous API call.

SubscriptionIds.N string[] Optional Sample value: SubscriptionIds.1=s-9ks1al1y9630lp******&SubscriptionIds.2=s-9ks1al1y9630lp******

The subscription ID. A maximum of 100 subscription IDs is supported. To obtain subscription IDs, you can call CreateSubscription to subscribe to event notifications or use this operation to query the list of subscribed notifications.

Argument - N: Specifies the serial number of the subscription ID.

Separate multiple subscription IDs with &.

Type string Optional Sample value: Notification

The subscription type. Value:

Notification: Message notification (SMS, email, internal message, and Feishu).

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

NextToken string Sample value: 6y6ug5ua2is5j0******

The query credentials value returned by this call. If null is returned, this page is the last page.

Subscriptions object[] Sample value: --

The subscription list.

CreatedAt string Sample value: 2022-11-18T19:11:46+08:00

The creation time.

EventTypes string[] Sample value: ["InstanceFailure:Succeeded", "AccountUnbalanced.Delete:Succeeded"]

The list of event types.

Id string Sample value: s-7uw3fs5vj0******

The subscription ID.

Type string Sample value: Notification

The subscription type.

UpdatedAt string Sample value: 2022-11-18T20:11:57+08:00

Update time.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	InvalidArgument	The specified argument is invalid.	The specified parameter is invalid.
400	LimitExceeded.MinimumMaxResults	The number of specified MaxResults exceeds the minimum limit.	The value specified for MaxResults exceeds the lower limit.
400	LimitExceeded.MaximumSubscriptionIds	The number of specified SubscriptionIds exceeds the maximum limit.	The number of specified subscription IDs exceeds the upper limit.
400	LimitExceeded.MaximumMaxResults	The number of specified MaxResults exceeds the maximum limit.	The value specified for MaxResults exceeds the upper limit.
400	InvalidType.Malformed	The specified Type is malformed.	The specified value of Type is invalid.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service