GetSubscription - 通知订阅详情

通知订阅详情。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /notify/subscription/detail HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求 Body。

subscriptionIdlong

订阅 ID。

10
notFilterScopeObjectDeletedboolean

是否过滤删除选项。

返回参数

名称类型描述示例值
object

响应结构。

requestIdstring

请求 ID。

10REQUES-AC5C-4B59-BE11-378F117A6A88
dataobject

返回结果。

subscriptionIdlong

订阅 ID。

68
subscriptionTitlestring

通知订阅名称。

newTitle
scopestring

订阅范围类型:

  • ALL:全部。
  • SERVICE:服务。
  • ROUTERULE:流转规则。
SERVICE
notifyObjectTypestring
  • SERVICEGROUP:服务组。
  • USER:个人。
USER
expiredTypestring

有效期类型:

  • LONG_TERM:长期。
  • SHORT_TERM:短期。
LONG_TERM
periodstring

时间段字符串。

1个月
startTimestring

时效开始时间。

2020-05-09 10:10:10
endTimestring

时效结束时间。

2021-08-09 10:10:10
statusstring
  • ENABLE:启用。
  • DISABLE:禁用。
ENABLE
scopeObjectListarray<object>

订阅范围列表。

scopeObjectListobject

订阅范围列表。

idlong

ID 主键。

10
scopestring

订阅范围类型:

  • ALL:全部。
  • SERVICE:服务。
  • ROUTERULE:流转规则。
SERVICE
scopeObjectIdlong

订阅范围对象关联表主键 ID。

10
scopeObjectstring

订阅范围对象名称。

阿里云
isValidlong

是否有效:

  • 0:无效。
  • 1:有效。
1
notifyObjectListarray<object>

通知对象列表。

notifyObjectListobject

通知对象列表。

idlong

ID 主键。

23
notifyObjectTypelong

通知对象类型:

  • SERVICEGROUP:服务组。
  • USER:个人。
USER
notifyObjectIdlong

关联主键 ID。

19
namestring

通知对象名称。

TestName
notifyStrategyListarray<object>

通知策略列表。

notifyStrategyListobject

通知订阅列表。

instanceTypelong

订阅实例类型:

  • INCIDENT:事件。
  • ALERT:报警。
  • PROBLEM:故障。
INCIDENT
strategiesarray<object>

策略。

strategiesobject

策略。

idlong

策略主键。

12
channelsstring

通知渠道。

SMS
conditionsarray<object>

条件。

conditionsobject

订阅条件。

effectionstring

影响范围。

HIGH
problemNotifyTypestring

故障通知类型。

PROBLEM_NOTIFY
levelstring

等级。

P1
actionstring

时间动作。

INCIDENT_TRIGGER
periodChannelobject

分时间段渠道。

workdaystring

工作时间。

DINGDING
nonWorkdaystring

非工作时间。

DINGDING

示例

正常返回示例

JSON格式

{
  "requestId": "10REQUES-AC5C-4B59-BE11-378F117A6A88",
  "data": {
    "subscriptionId": 68,
    "subscriptionTitle": "newTitle",
    "scope": "SERVICE",
    "notifyObjectType": "USER",
    "expiredType": "LONG_TERM",
    "period": "1个月",
    "startTime": "2020-05-09 10:10:10",
    "endTime": "2021-08-09 10:10:10",
    "status": "ENABLE",
    "scopeObjectList": [
      {
        "id": 10,
        "scope": "SERVICE",
        "scopeObjectId": 10,
        "scopeObject": "阿里云",
        "isValid": 1
      }
    ],
    "notifyObjectList": [
      {
        "id": 23,
        "notifyObjectType": 0,
        "notifyObjectId": 19,
        "name": "TestName"
      }
    ],
    "notifyStrategyList": [
      {
        "instanceType": 0,
        "strategies": [
          {
            "id": 12,
            "channels": "SMS",
            "conditions": [
              {
                "effection": "HIGH",
                "problemNotifyType": "PROBLEM_NOTIFY",
                "level": "P1",
                "action": "INCIDENT_TRIGGER"
              }
            ],
            "periodChannel": {
              "workday": "DINGDING",
              "nonWorkday": "DINGDING"
            }
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404NotifySubsNotExistsThe specified subscription does not exist.通知订阅不存在

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