CreateSanityCheckTask - CreateSanityCheckTask

更新时间:
复制 MD 格式

用于为指定的 DSW 实例提交一个异步健康检查任务。调用时需提供检查类型(如 ssh)和实例 ID,系统将立即返回一个唯一的任务 ID(TaskID),表示任务已成功入队。该接口不阻塞等待检查结果,适用于需要快速响应的场景,后续可通过任务 ID 查询执行状态与详细结果。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidsw:CreateSanityCheckTask

create

*全部资源

*

请求语法

POST /api/v2/sanitychecks/{CheckType} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

CheckType

string

检查项类型。取值:

  • SSH:用于触发实例 SSH 联通性健康检查

  • CustomService:用于触发实例自定义服务的联通性健康检查

SSH

请求参数

名称

类型

必填

描述

示例值

body

object

请求 body。

InstanceId

string

实例 ID。如何获取实例 ID,请参见 ListInstances

dsw-730xxxxxxxxxx

CheckArgs

object

健康检查所需的额外参数。 eg:

  • "ServiceName": "需要检查的自定义服务名称"

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

BEBDF2EE-642E-5992-8907-D2011A7ACEFE

TaskId

string

创建的健康检查任务 ID

917479ff-c869-49ea-908e-ae85bd987bc0

示例

正常返回示例

JSON格式

{
  "RequestId": "BEBDF2EE-642E-5992-8907-D2011A7ACEFE\n",
  "TaskId": "917479ff-c869-49ea-908e-ae85bd987bc0"
}

错误码

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

变更历史

更多信息,参考变更详情