CreateInventoryJob - 创建盘点任务

更新时间:
复制 MD 格式

创建资产盘点任务,对指定实例/数据库/表进行知识盘点

接口说明

创建资产盘点任务,支持选择实例、数据库、表维度进行知识盘点,返回任务 ID

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateInventoryJob

none

*全部资源

*

请求语法

POST / HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

Param

string

盘点参数的 json 字符串

参数名类型必填说明
instanceIdsList<Integer>盘点选择的实例 ID 列表
dbIdsList<Integer>盘点选择的数据库 ID 列表
tableIdsMap<Integer, List<String>>盘点选择的表列表,key 为数据库 ID,value 为该数据库下的表名列表

{ "instanceIds": [1], "dbIds": [2], "tableIds": { "3": [ "table" ] } }

返回参数

名称

类型

描述

示例值

object

返回内容

RequestId

string

Id of the request

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

ErrorCode

string

错误码。

UnknownError

ErrorMessage

string

错误信息。

UnknownError

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功

  • false:请求失败

true

Data

integer

盘点任务 ID

1001

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": 1001
}

错误码

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

变更历史

更多信息,参考变更详情