CreateInventoryJob

Operation description

Creates an asset inventory task. You can select instances, databases, or tables as the inventory dimension. The task ID is returned.

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

dms:CreateInventoryJob

none

*All Resource

*

None

Request syntax

POST / HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

Param

string

No

The JSON string of inventory parameters.

Parameter	Type	Required	Description
`instanceIds`	`List<Integer>`	No	The list of instance IDs selected for inventory.
`dbIds`	`List<Integer>`	No	The list of database IDs selected for inventory.
`tableIds`	`Map<Integer, List<String>>`	No	The list of tables selected for inventory. The key is the database ID, and the value is the list of table names in the database.

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

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	Id of the request	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request failed.	true
Data	integer	The inventory task ID.	1001

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.