ListSubscriptions - 查询订阅

更新时间:
复制 MD 格式

查询订阅

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:ListSubscriptions

list

*Subscription

acs:cms:{#regionId}:{#accountId}:subscription/*

无 无

请求语法

GET /subscriptions HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

subscriptionName

string

否

订阅名称

测试订阅

subscriptionId

string

否

订阅 ID。

123123123123

enable

boolean

否

是否启用。

false

workspace

string

否

工作空间名称

workspace-test

nextToken

string

否

分页 Token

2-3408-4595-9d80-****

maxResults

integer

否

分页大小

10

direction

string

否

返回的版本排序方向。 asc 正序 desc 倒序

asc

orderBy

string

否

排序字段

id

subscriptionType

string

否

订阅类型。取值:NORMAL(标准订阅)、AI_AGENT(AI 智能体订阅)。

NORMAL

notifyStrategyUuid

string

否

通知策略 UUID。用于筛选绑定了指定通知策略的订阅,为 32 位字符串。

1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d

unbound deprecated

boolean

否

已废弃(deprecated)的内部保留参数,请勿使用。

true

agentUuid

string

否

AI 智能体 UUID。用于筛选指定 AI 智能体的订阅。

agent-rca-001

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

请求 ID。

123-123-234-345-123

subscriptionList

array

订阅列表

SubscriptionForView

订阅对象

nextToken

string

分页 Token

2-3408-4595-9d80-****

maxResults

integer

MaxResults 本次请求所返回的最大记录条数

10

示例

正常返回示例

JSON格式

{
  "requestId": "123-123-234-345-123",
  "subscriptionList": [
    {
      "createTime": "2025-03-11T08:21:58Z",
      "description": "workspace test",
      "enable": false,
      "subscriptionName": "订阅测试",
      "notifyStrategyId": "23123123",
      "updateTime": "2025-05-23T02:29:02Z",
      "userId": "123123123",
      "subscriptionId": "123123123123",
      "workspace": "workspace-test",
      "filterSetting": {
        "conditions": [
          {
            "field": "labels.alertname\t",
            "op": "EQ",
            "value": "CRITICAL"
          }
        ],
        "expression": "1 and 2 or 3",
        "relation": "AND"
      },
      "pushingSetting": {
        "templateUuid": "123123123",
        "alertActionIds": [
          "123123123"
        ],
        "restoreActionIds": [
          "123123123"
        ],
        "responsePlanId": "123123123"
      },
      "syncFromType": "\"ARMS\"",
      "workspaceFilterSetting": {
        "tagSelector": {
          "conditions": [
            {
              "field": "labels.alertname\t",
              "op": "EQ",
              "value": "CRITICAL"
            }
          ],
          "expression": "1 and 2 or 3",
          "relation": "AND"
        },
        "workspaceUuids": [
          "\"ws-abc123\""
        ]
      },
      "subscriptionType": "NORMAL",
      "agentConfig": {
        "agentUuid": "agent-uuid-001",
        "routes": [
          {
            "channels": [
              {
                "channelType": "default",
                "receivers": [
                  "my-contact"
                ],
                "enabledSubChannels": [
                  "SMS"
                ]
              }
            ],
            "effectTimeRange": {
              "timeZone": "1700000000",
              "dayInWeek": [
                1
              ],
              "startTimeInMinute": 1,
              "endTimeInMinute": 1
            }
          }
        ]
      },
      "subscribeLegacyEvent": false
    }
  ],
  "nextToken": "2-3408-4595-9d80-****",
  "maxResults": 10
}

错误码

HTTP status code

错误码

错误信息

描述

400 ParameterInvalid The parameter is missing or invalid. %s 参数缺失或者参数无效。
500 InternalUnknownError The request processing has failed due to some unknown error. 服务运行错误。
403 Forbidden You are not authorized to operate the specified resource. 没有权限,请使用RAM进行授权
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。