GetUploadOssUrl

更新时间:
复制 MD 格式

This API generates a temporary URL for uploading to OSS in the public cloud.

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

oceanbase:GetUploadOssUrl

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Type

string

Yes

The action type. Set this to CREATE_PROJECT.

CREATE_PROJECT

EffectiveTimeMinutes

integer

No

The validity period in minutes. The value must be an integer from 1 to 30. The default is 10.

10

Response elements

Element

Type

Description

Example

object

The response body.

Success

boolean

Indicates whether the request was successful.

true

ErrorDetail

object

The error detail.

Code

string

The error code.

CM-RESOAT1111

Level

string

The error severity level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.

ERROR

Message

string

The error message.

null

ExtraContext

object

A map of key-value pairs for placeholders in the Message parameter.

any

The context used to populate placeholders in the Message parameter.

null

MessageMcmsKey

string

The key for the error message.

null

MessageMcmsContext

object

The context used to populate placeholders for the MessageMcmsKey parameter.

string

The context used to populate placeholders for the MessageMcmsKey parameter.

null

Reason

string

The cause of the error.

null

ReasonMcmsKey

string

The key for the error reason.

null

ReasonMcmsContext

object

The context for the error reason.

string

The context for the error reason.

null

Proposal

string

The suggestion.

null

ProposalMcmsKey

string

The key for the suggestion.

null

ProposalMcmsContext

object

The context for the suggestion.

string

The context for the suggestion.

null

UpstreamErrorDetail

any

Details of the error from an upstream service.

null

Code

string

The legacy error code.

INNER_ERROR

Message

string

The legacy error message.

A system error occurred.

Advice

string

The legacy suggestion.

Contact the administrator.

RequestId

string

The request ID.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

PageNumber

integer

The page number. This parameter is returned only for paginated queries.

1

PageSize

integer

The page size. This parameter is returned only for paginated queries.

10

TotalCount

integer

The total count. This parameter is returned only for paginated queries.

11

Cost

string

The request duration, in seconds.

278

Data

object

The presigned URL and related details for Object Storage Service (OSS).

OssUrl

string

The presigned URL for uploading content to OSS.

https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp******?Expires=169031&OSSAccessKeyId=LTAI****************&Signature=XdDF****************

OssKey

string

The object key to pass in subsequent API calls.

open_api_create_project/oacp_4xd****

ExpectedExpirationTime

string

The expected expiration time of the OssUrl, in UTC.

2023-07-26T06:33:11.175

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "\t\nCM-RESOAT1111\n",
    "Level": "ERROR",
    "Message": "null",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "null",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator.",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 11,
  "Cost": "278",
  "Data": {
    "OssUrl": "https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp******?Expires=169031&OSSAccessKeyId=LTAI****************&Signature=XdDF****************",
    "OssKey": "open_api_create_project/oacp_4xd****",
    "ExpectedExpirationTime": "2023-07-26T06:33:11.175\n"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.