CLI命令参考
订阅用户
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 添加订阅用户 | hcloud SMNGLOBAL CreateSubscriptionUser | 添加订阅用户。如果订阅用户的状态为未确认，则会向订阅用户发送一条确认订阅消息。订阅用户点击订阅链接确认订阅后，则订阅用户的状态变更为已确认，同时会向订阅用户发送一条取消订阅消息，便于订阅用户随时可以取消订阅。订阅用户点击取消订阅链接后，则订阅用户的状态变更为已取消，同时会向订阅用户发送一条重新订阅消息，便于订阅用户可以重新订阅。 | |
| 查询订阅用户列表 | hcloud SMNGLOBAL ListSubscriptionUser | 查询订阅用户列表。 | |
| 删除订阅用户 | hcloud SMNGLOBAL DeleteSubscriptionUser | 删除订阅用户。 | |
| 更新订阅用户 | hcloud SMNGLOBAL UpdateSubscriptionUser | 更新订阅用户。 |
主题操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询主题列表 | hcloud SMN ListTopics | 分页查询Topic列表，Topic列表按照Topic创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在Topic，则返回空列表。 | |
| 创建主题 | hcloud SMN CreateTopic | 创建Topic，单用户默认配额为3000。高并发场景下，可能会出现Topic数量超过3000仍创建成功的情况，此为正常现象。 | |
| 查询主题详情 | hcloud SMN ListTopicDetails | 查询Topic的详细信息。 | |
| 更新主题 | hcloud SMN UpdateTopic | 更新显示名。 | |
| 删除主题 | hcloud SMN DeleteTopic | 删除主题。 | |
| 查询主题策略 | hcloud SMN ListTopicAttributes | 查询主题的策略信息。 | |
| 删除所有主题策略 | hcloud SMN DeleteTopicAttributes | 删除所有主题策略。 | |
| 更新主题策略 | hcloud SMN UpdateTopicAttribute | 更新主题的策略信息。 | |
| 删除指定名称的主题策略 | hcloud SMN DeleteTopicAttributeByName | 删除指定名称的主题策略。 | |
| 查询主题的发送详情 | hcloud SMN ListTopicMessageStatistics | 查询Topic的发送数据详情，最多支持查询31天内所有计量数据 | |
| 查询主题列表及主题关联资源信息 | hcloud SMN ListTopicsWithAssociatedResources | 查询Topic及Topic关联资源信息列表，关联资源信息随业务演进会持续扩展。Topic列表默认按照创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在Topic，则返回空列表。 |
订阅操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量删除订阅 | hcloud SMN BatchDeleteSubscriptions | 批量删除订阅，每个订阅终端的删除结果在响应体中依次展示。 | |
| 查询订阅者列表 | hcloud SMN ListSubscriptions | 分页返回请求者的所有的订阅列表，订阅列表按照订阅创建时间进行升序排列。分页查询可以指定offset以及limit。如果订阅者不存在，返回空列表。 | |
| 批量删除指定主题的订阅 | hcloud SMN BatchDeleteSubscriptionsByTopic | 批量删除指定主题的订阅，每个订阅终端的删除结果在响应体中依次展示。 | |
| 查询指定Topic的订阅者列表 | hcloud SMN ListSubscriptionsByTopic | 分页获取特定Topic的订阅列表，订阅列表按照订阅创建时间进行升序排列。分页查询可以指定offset以及limit。如果指定Topic不存在订阅者，返回空列表。 | |
| 订阅 | hcloud SMN AddSubscription | 为指定Topic添加一个订阅者，如果订阅者的状态为未确认，则向订阅者发送一个确认的消息。待订阅者进行ConfirmSubscription确认后，该订阅者才能收到Topic发布的消息。单Topic默认可添加10000个订阅者，高并发场景下，可能会出现订阅者数量超过10000仍添加成功的情况，此为正常现象。接口是幂等的，如果添加已存在的订阅者，则返回成功，且status code为200，否则status code为201。 | |
| 取消订阅 | hcloud SMN CancelSubscription | 删除指定的订阅者。 | |
| 删除指定主题的订阅 | hcloud SMN DeleteSubscriptionsByTopic | 删除指定主题的订阅 | |
| 更新订阅者 | hcloud SMN UpdateSubscription | 更新订阅者备注。 | |
| 导入订阅 | hcloud SMN AddSubscriptionFromSubscriptionUser | 为指定的Topic添加订阅者，订阅者信息来源为订阅用户列表。 | |
| 确认订阅 | hcloud SMN ConfirmSubscription | 确认订阅主题消息。 | |
| 取消订阅 | hcloud SMN UnsubscribeSubscription | 取消订阅主题 | |
| 订阅主题 | hcloud SMN SubscribeTopic | 订阅终端确认订阅主题消息。 | |
| 取消订阅主题 | hcloud SMN UnsubscribeTopic | 订阅终端取消订阅主题消息。 |
模板操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询消息模板列表 | hcloud SMN ListMessageTemplates | 分页查询模板列表，模板列表按照创建时间进行升序排列。分页查询可以指定offset以及limit。如果不存在模板，则返回空列表。额外的查询参数分别有message_template_name和protocol。 | |
| 创建消息模板 | hcloud SMN CreateMessageTemplate | 创建一个模板，用户可以按照模板去发送消息，这样可以减少请求的数据量。 | |
| 查询消息模板详情 | hcloud SMN ListMessageTemplateDetails | 查询模板详情，包括模板内容。 | |
| 更新消息模板 | hcloud SMN UpdateMessageTemplate | 修改消息模板的内容。 | |
| 删除消息模板 | hcloud SMN DeleteMessageTemplate | 删除消息模板。删除模板之前的消息请求都可以使用该模板发送，删除之后无法再使用该模板发送消息。 |
发布消息操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 消息发布 | hcloud SMN PublishMessage | 将消息发送给Topic的所有订阅端点。当返回消息ID时，该消息已被保存并开始尝试将其推送给Topic的订阅者。为确保您的消息能够成功推送到各个订阅者，请确保您的消息内容符合当地法律法规要求。 | |
| 发布探测消息 | hcloud SMN PublishHttpDetect | 基于主题发送http/https探测消息，探测当前http/https 终端是否可用，SMN出口是否能够正常访问该终端。 | |
| 获取http探测结果 | hcloud SMN ShowHttpDetectResult | 根据http探测发送返回的task_id查询探测结果。 |
使用标签管理服务
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询资源实例 | hcloud SMN ListResourceInstances | 使用标签过滤实例。 | |
| 批量添加删除资源标签 | hcloud SMN BatchCreateOrDeleteResourceTags | 为指定实例批量添加或删除标签。一个资源上最多有10个标签。 | |
| 查询资源标签 | hcloud SMN ListResourceTags | 查询指定实例的标签信息。 | |
| 添加资源标签 | hcloud SMN CreateResourceTag | 一个资源上最多有10个标签。此接口为幂等接口：创建时，如果创建的标签已经存在（key相同），则覆盖。 | |
| 查询项目标签 | hcloud SMN ListProjectTags | 查询租户在指定Region和实例类型的所有标签集合。 | |
| 删除资源标签 | hcloud SMN DeleteResourceTag | 幂等接口：删除时，不对标签做校验。删除的key不存在报404，key不能为空或者空字符串。 |
Application操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询Application | hcloud SMN ListApplications | 查询应用平台列表。 | |
| 创建Application | hcloud SMN CreateApplication | 创建平台应用。 | |
| 查询Application属性 | hcloud SMN ListApplicationAttributes | 获取应用平台属性。 | |
| 更新Application | hcloud SMN UpdateApplication | 更新应用平台。 | |
| 删除Application | hcloud SMN DeleteApplication | 删除平台应用。 |
Application endpoint操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询Application的Endpoint列表 | hcloud SMN ListApplicationEndpoints | 查询平台的endpoint列表。 | |
| 创建Application endpoint | hcloud SMN CreateApplicationEndpoint | 创建应用平台的endpoint终端。 | |
| 查询Application的Endpoint属性 | hcloud SMN ListApplicationEndpointAttributes | 获取endpoint的属性。 | |
| 更新Application endpoint | hcloud SMN UpdateApplicationEndpoint | 更新设备属性。 | |
| 删除Application endpoint | hcloud SMN DeleteApplicationEndpoint | 删除设备。 |
Application直发消息操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| App消息发布 | hcloud SMN PublishAppMessage | 将消息直发给endpoint设备。 |
查询版本操作
云日志操作
订阅过滤策略操作
通知策略
协议操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询协议列表 | hcloud SMN ListProtocols | 查询SMN支持的协议列表。 |
授权云服务操作
证书操作
密钥操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 主题绑定KMS密钥 | hcloud SMN CreateKmsKey | 为主题绑定KMS密钥。KMS密钥于绑定后五分钟生效，生效后该主题下发布的消息（确认订阅消息、取消订阅消息、主题消息）均使用指定密钥的数据密钥进行加解密，并将消息内容在SMN服务内部加密传输。执行绑定KMS密钥时，用户需要先在IAM处创建名为smn_kms_agency的委托，并将资源操作权限授权给SMN服务。SMN会使用该委托进行创建数据密钥操作。 | |
| 查询主题下KMS密钥 | hcloud SMN ShowKmsKey | 查询主题下密钥ID。执行绑定KMS密钥时，用户需要先在IAM处创建名为smn_kms_agency的委托，并将资源操作权限授权给SMN服务。SMN会使用该委托进行查询密钥信息操作。 | |
| 更新主题下KMS密钥 | hcloud SMN UpdateKmsKey | 更新密钥ID。执行更新KMS密钥时，用户需要先在IAM处创建名为smn_kms_agency的委托，并将对应的资源操作权限授权给SMN服务。SMN会使用该委托进行查询密钥状态和创建数据密钥操作。 | |
| 删除主题下KMS密钥 | hcloud SMN DeleteKmsKey | 删除主题绑定的密钥。 |
