DescribeSubscriptions - 查询事件通知订阅列表--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeSubscriptions - 查询事件通知订阅列表

最近更新时间：2024.05.21 10:26:16首次发布时间：2023.01.06 07:41:48

调用 DescribeSubscriptions 接口，查询事件通知订阅列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeSubscriptions	要执行的操作，取值：DescribeSubscriptions。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
SubscriptionIds.N	Array of String	否	SubscriptionIds.1=s-9ks1al1y9630lp****&SubscriptionIds.2=s-9ks1al1y9630lp****	订阅ID，最多支持100个ID。您可以调用CreateSubscription接口订阅事件通知，或调用本接口查询已订阅通知列表获取。参数 - N：表示订阅ID的序号。多个订阅ID之间用`&`分隔。
Type	String	否	Notification	订阅类型，取值： Notification：消息通知(短信/邮件/站内信/飞书)。
NextToken	String	否	--	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
MaxResults	Integer	否	20	分页查询时设置的每页行数。默认值：20 最大值：100 最小值：0

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
NextToken	String	6y6ug5ua2is5j0******	本次调用返回的查询凭证值，返回为空表示该页为末页。
Subscriptions	Array of SubscriptionsForDescribeSubscriptions	--	订阅列表。

请求示例

GET /?Action=DescribeSubscriptions&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeSubscriptions",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "Subscriptions": [
            {
                "Id": "s-7uw3fs5vj0******",
                "EventTypes": ["AccountUnbalanced.Stop:Succeeded", "FileSystemReadOnly.Change:Succeeded"],
                "Type": "Notification",
                "CreatedAt": "2022-11-18T19:11:46+08:00",
                "UpdatedAt": "2022-11-18T20:11:57+08:00"
            }
        ],
        "NextToken": ""
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	LimitExceeded.MinimumMaxResults	The number of specified MaxResults exceeds the minimum limit.	指定的MaxResults超过最小限制。
400	LimitExceeded.MaximumSubscriptionIds	The number of specified SubscriptionIds exceeds the maximum limit.	指定的SubscriptionIds超过最大限制。
400	LimitExceeded.MaximumMaxResults	The number of specified MaxResults exceeds the maximum limit.	指定的MaxResults超过最大限制。
400	InvalidType.Malformed	The specified Type is malformed.	指定的Type不合法。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。