DescribeInventoryFileUploadSignature - Data Management - Alibaba Cloud Documentation Center

Retrieves OSS direct upload credentials for asset inventory files.

Operation description

Generates an OSS PostObject V4 direct upload signature for asset inventory document uploads. The client uses the returned uploadHost, uploadDir, policy, ossCredential, ossDate, ossSignature, and ossSecurityToken to upload files directly. After a successful upload, pass the OSS key as the InputFiles parameter of CreateInventoryJob.

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:DescribeInventoryFileUploadSignature

none

*All Resource

*

None

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
JobToken	string	No	The idempotency token for the upload directory. You can pass an inventory task draft ID or a client-generated UUID. If not specified, the server generates a random directory.	inventory-draft-20260613

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 was successful.	true
Data	object	The OSS direct upload signature information.
OssCredential	string	The parameter set that specifies the derived key.	eyJleHBpcmFxxx
OssDate	string	The time of the request in ISO 8601 format.	20260617T093434Z
OssSignatureVersion	string	The signature version and algorithm.	OSS4-HMAC-SHA256
OssSignature	string	The description information used for signature authentication.	6475cdb70e1a5xxx
OssSecurityToken	string	The STS token used to upload files to OSS. The token is valid for 1 hour.	CAIS5QJ1q6Ft5xxx
Policy	string	The policy content.	eyJleHBpcxxx
UploadHost	string	The destination address for file uploads.	https://dms-metaagentxxx
UploadDir	string	The path for file uploads.	metaagent_inventory/xxx
MaxFileSizeBytes	integer	The maximum file size allowed for uploads.	209715200

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "OssCredential": "eyJleHBpcmFxxx",
    "OssDate": "20260617T093434Z",
    "OssSignatureVersion": "OSS4-HMAC-SHA256",
    "OssSignature": "6475cdb70e1a5xxx",
    "OssSecurityToken": "CAIS5QJ1q6Ft5xxx",
    "Policy": "eyJleHBpcxxx",
    "UploadHost": "https://dms-metaagentxxx",
    "UploadDir": "metaagent_inventory/xxx",
    "MaxFileSizeBytes": 209715200
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.