GetEventSubscription - Database Autonomy Service - Alibaba Cloud Documentation Center

Queries the event subscription settings of a database instance.

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK or a Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.
The database instance that you want to manage is connected to DAS.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:GetEventSubscription	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
Data	object	The data returned.
userId	string	The user ID.	1088760496****
instanceId	string	The instance ID.	rm-2ze8g2am97624****
eventContext	string	The supported event scenarios. Only AllContext may be returned, which indicates that all scenarios are supported.	AllContext
lang	string	The language of event notifications. Only zh-CN may be returned, which indicates that event notifications are sent in Chinese.	zh_CN
active	integer	Indicates whether the event subscription feature is enabled. Valid values: 0: The event subscription feature is disabled. 1: The event subscription feature is enabled.	1
minInterval	string	The minimum interval between event notifications. Unit: seconds.	60
contactName	string	The name of the subscriber who receives alert notifications. Multiple names are separated by commas (,).	Default contact
contactGroupName	string	The name of the contact group that receives alert notifications. Multiple names are separated by commas (,).	Default contact group
channelType	string	The notification method. Valid values: hdm_alarm_sms: text message. dingtalk: DingTalk chatbot. hdm_alarm_sms_and_email: text message and email. hdm_alarm_sms,dingtalk: text message and DingTalk chatbot.	hdm_alarm_sms,dingtalk
level	string	The risk level of the events that trigger notifications. Valid values: Notice Optimization Warn Critical	Optimization
contacts	object []	The user ID.
name	string	The name of the alert contact.	Mr. Zhang
phone	string	The mobile number of the alert contact.	1390000****
email	string	The email address of the alert contact.	a***@example.net
dingtalkHook	string	The webhook URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****
groups	array	The contact groups to which the alert contact belongs.
	string	The name of the alert contact.	Mr. Zhang
isCmsReduplicated	boolean	Indicates whether the alert contact name is the same as the contact name on CloudMonitor. true false	true
userId	string	The user ID.	1088760496****
contactGroups	object []	The alert contact groups.
name	string	The name of the alert contact group.	Mr. Zhang
description	string	The description of the alert contact group.	Default contact
contacts	string	The members of the alert contact group.	"[\"Mr. Zhang\",\"Ms. Wang\",\"Mr. Li\"]"
userId	string	The user ID.	1088760496****
eventSendGroup	array	The supported event scenarios in which event subscription can be sent.
	string	The supported event scenario in which event notifications can be sent. Only AllContext may be returned, which indicates that all scenarios are supported.	AllContext
id	long	The primary key ID of the database.	1
gmtCreate	long	The time when event subscription was enabled. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1633071840000
gmtModified	long	The time when the event subscription settings were most recently modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1633071850000
Code	string	The HTTP status code returned.	200
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Message": "Successful",
  "Data": {
    "userId": "1088760496****",
    "instanceId": "rm-2ze8g2am97624****",
    "eventContext": "AllContext",
    "lang": "zh_CN",
    "active": 1,
    "minInterval": "60",
    "contactName": "Default contact",
    "contactGroupName": "Default contact group",
    "channelType": "hdm_alarm_sms,dingtalk",
    "level": "Optimization",
    "contacts": [
      {
        "name": "Mr. Zhang",
        "phone": "1390000****",
        "email": "a***@example.net",
        "dingtalkHook": "https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****",
        "groups": [
          "Mr. Zhang"
        ],
        "isCmsReduplicated": true,
        "userId": "1088760496****"
      }
    ],
    "contactGroups": [
      {
        "name": "Mr. Zhang",
        "description": "Default contact",
        "contacts": "\"[\\\"Mr. Zhang\\\",\\\"Ms. Wang\\\",\\\"Mr. Li\\\"]\"",
        "userId": "1088760496****"
      }
    ],
    "eventSendGroup": [
      "AllContext"
    ],
    "id": 1,
    "gmtCreate": 1633071840000,
    "gmtModified": 1633071850000
  },
  "Code": "200",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history