文档

OrderClusterHealthCheckRiskNotice - 订阅风险项通知

更新时间:

是否订阅风险项通知功能。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:OrderClusterHealthCheckRiskNoticeRead
  • 全部资源
    *

请求参数

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

实例 ID。

mse-cn-st21ri2****
RiskCodestring

风险编码。

30010010001
Muteboolean

是否禁用此风险项通知功能。

  • true 禁用风险项通知
  • false 开启风险项通知
false
NoticeTypestring

预留参数。

null
RegionIdstring

集群所在地域。

cn-hangzhou
RequestParsstring

扩展请求参数,JSON 格式。

{}
AcceptLanguagestring

返回信息的语言类型。

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

RestResult

RequestIdstring

请求 ID。

AF21683A-29C7-4853-AC0F-B5ADEE4D****
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Codeinteger

code 仅仅用来和 success 同步

200
ErrorCodestring

错误码。

mse-100-000
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

  • 当请求成功时,返回成功信息。
  • 当请求失败时,返回失败原因,例如:TaskId not found。
请求处理成功
DynamicCodestring

动态错误信息中的占位符

code
DynamicMessagestring

动态错误信息,用于替换返回参数 ErrMessage 错误信息中的**%s**。

说明 如果 ErrMessage 返回The Value of Input Parameter %s is not valid,且 DynamicMessage 返回 DtsJobId,则代表所传入的请求参数 DtsJobId 不合法。
The specified parameter is invalid.
Databoolean

是否订阅成功

true

示例

正常返回示例

JSON格式

{
  "RequestId": "AF21683A-29C7-4853-AC0F-B5ADEE4D****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": true
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

  • 本页导读 (1)
文档反馈