OrderClusterHealthCheckRiskNotice - Microservices Engine

Subscribes to the notification feature if a risk is detected during a health check.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
mse:OrderClusterHealthCheckRiskNotice	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance.	mse-cn-st21ri2****
RiskCode	string	No	The ID of the risk item.	30010010001
Mute	boolean	No	Specifies whether to disable the notification feature if the risk item occurs. true: disabled false: enabled	false
NoticeType	string	No	A reserved parameter.	null
RegionId	string	No	The region in which the cluster resides.	cn-hangzhou
RequestPars	string	No	The extended request parameters in the JSON format.	{}
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	RestResult
RequestId	string	The ID of the request.	AF21683A-29C7-4853-AC0F-B5ADEE4D****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The status code. A value of 200 is returned if the request is successful.	200
ErrorCode	string	The error code returned if the request failed.	mse-100-000
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned, such as the "TaskId not found" message.	The request is successfully processed.
DynamicCode	string	The dynamic part in the error message.	code
DynamicMessage	string	The dynamic part in the error message. This parameter is used to replace the %s variable in the ErrMessage parameter. Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.	The specified parameter is invalid.
Data	boolean	Indicates whether the subscription was successful.	null

Examples

Sample success responses

JSONformat

{
  "RequestId": "AF21683A-29C7-4853-AC0F-B5ADEE4D****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

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