Use PutContact to create or modify an alert contact - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:PutContact

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ContactName	string	Yes	The name of the alert contact.	Alice
Describe	string	Yes	The description of the alert contact.	ECS_Instance
Channels.SMS	string	No	The phone number of the alert contact. An activation link is sent to the phone number. The alert contact is added only after the link is activated. Specify at least one of the following contact methods: email address or DingTalk chatbot. .	1333333****
Channels.Mail	string	No	The email address of the alert contact. An activation link is sent to the email address. The alert contact is added only after the link is activated. Specify at least one of the following contact methods: email address or DingTalk chatbot. .	test@aliyun.com
Channels.AliIM	string	No	The TradeManager ID of the alert contact. Specify at least one of the following contact methods: email address or DingTalk chatbot. .	Jim
Channels.DingWebHook	string	No	The webhook URL of the DingTalk chatbot. Specify at least one of the following contact methods: email address or DingTalk chatbot. .	https://oapi.dingtalk.com/robot/send?access_token=7d49515e8ebf21106a80a9cc4bb3d247771305d52fb15d6201234565****
Lang	string	No	The language in which alert notifications are sent. Valid values: zh-cn: simplified Chinese. en: English. Note If you do not set this parameter, the language is automatically determined based on the region of the account.	zh-cn

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code. Note The value 200 indicates success.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The request ID.	181C406E-9DE4-484C-9C61-37AE9A1A12EE
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "181C406E-9DE4-484C-9C61-37AE9A1A12EE",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameterValue	%s
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidAuthorization	Permission denied	Permission denied.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.