GetToken

更新时间:
复制 MD 格式

Retrieves the temporary authentication information for a specified DSW instance.

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

paidsw:GetToken

get

*All Resource

*

None None

Request syntax

GET /api/v2/tokens HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID. For information about how to obtain an instance ID, see ListInstances.

dsw-730xxxxxxxxxx

ExpireTime

integer

No

The time-to-live (TTL). Unit: seconds.

60

Type

string

No

The type of token to issue.

  • Access: Grants permissions to enter a DSW instance and perform operations.

  • View: Grants read-only permissions to share DSW instance information, such as status, configuration, and logs. This type does not grant permissions to modify or control the instance. It is suitable for collaborators or external viewers.

Access

Audience

string

No

Specifies the intended recipient (audience) of the token. If you access the DSW page from a self-built web application, set this parameter to ThirdParty.

Aliyun

Response elements

Element

Type

Description

Example

object

The response struct.

RequestId

string

The request ID.

E7D55162-4489-1619-AAF5-3F97D5FCA948

Success

boolean

Indicates whether the request was successful. Possible values:

  • true

  • false

Valid values:

  • true :

    true

  • false :

    false

true

Message

string

The error message.

"XXX"

Code

string

The status code. Possible values:

  • InternalError: An internal error. This includes all errors except for parameter validation errors.

  • ValidationError: A parameter validation error.

ValidationError

Token

string

The temporary authentication information used to access the DSW instance.

*******

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "ValidationError",
  "Token": "*******"
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.