DocsICP FilingConsole
Documentation

DescribeFileUploadSignature

Updated at:
Copy as MD
Product
My Favorites

Retrieves the signature information for file uploads.

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

get

*All Resource

*

 None None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
DmsUnit

string

No

The current DMS unit.

cn-hangzhou

CallFrom

string

No

For frontend use only.

For frontend use only
WorkspaceId

string

No

The workspace ID.

yrgug4e*******ypey63v

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

0FEE5834-C55A-5995-A6A3-B443304965BD
Data

object

The response struct.

OssCredential

string

The parameter set that specifies the derived key.

STS.NXzWrLJ6fp**********/20260101/cn-hangzhou/oss/aliyun_v4_request
OssDate

string

The time of the request, which follows the ISO 8601 date and time standard.

20260101T135341Z
OssSignatureVersion

string

The version and algorithm of the signature.

OSS4-HMAC-SHA256
OssSignature

string

The description used for signature authentication.

9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********
OssSecurityToken

string

The STS token used to upload files to OSS, valid for one hour.

CAIS4gJ1q6Ft5B2yfSjIr5vPHMj4p+lHx/utUUjg13ptZ+5u3oDzkzz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9y7dIs8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIj6Zlmz+/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+rfShhfFuG2QagAECCyigwAlSAryrFmteD+EVuvxvi0NE7zDJLbUkhek6dcY+/u5V5jcmvL67CQ7bTNk+9lV8WDCvtoCD9ucqTaHweJEd8fS2DaFedAMDf8BfZa2C1CTLhVXdSgE2WORYbMqidelRm7dH3fTbZVvryWKDaveDRLt5J/Qfs**********
Policy

string

The permission limits and constraints for file uploads.

eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5YeldyTEo2ZnA5RlNuUTN6OGthQjFFWH**********

UploadHost

string

The destination address for file uploads.

https://**********.oss-cn-hangzhou.aliyuncs.com
UploadDir

string

The path for file uploads.

data_agent/file_upload/16738266********/20260101T135341Z/eurzkytli9ksnur**********
Success

boolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.

  • false: The request fails.

true
ErrorCode

string

The error code.

success
ErrorMessage

string

The error message returned when the call fails.

Specified parameter Tid is not valid.

Examples

Success response

JSON format

{
  "RequestId": "0FEE5834-C55A-5995-A6A3-B443304965BD",
  "Data": {
    "OssCredential": "STS.NXzWrLJ6fp**********/20260101/cn-hangzhou/oss/aliyun_v4_request",
    "OssDate": "20260101T135341Z",
    "OssSignatureVersion": "OSS4-HMAC-SHA256",
    "OssSignature": "9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********",
    "OssSecurityToken": "CAIS4gJ1q6Ft5B2yfSjIr5vPHMj4p+lHx/utUUjg13ptZ+5u3oDzkzz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9y7dIs8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIj6Zlmz+/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+rfShhfFuG2QagAECCyigwAlSAryrFmteD+EVuvxvi0NE7zDJLbUkhek6dcY+/u5V5jcmvL67CQ7bTNk+9lV8WDCvtoCD9ucqTaHweJEd8fS2DaFedAMDf8BfZa2C1CTLhVXdSgE2WORYbMqidelRm7dH3fTbZVvryWKDaveDRLt5J/Qfs**********",
    "Policy": "eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5YeldyTEo2ZnA5RlNuUTN6OGthQjFFWH**********\n",
    "UploadHost": "https://**********.oss-cn-hangzhou.aliyuncs.com",
    "UploadDir": "data_agent/file_upload/16738266********/20260101T135341Z/eurzkytli9ksnur**********"
  },
  "Success": true,
  "ErrorCode": "success",
  "ErrorMessage": "Specified parameter Tid is not valid."
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.