Use GetToken API for Temporary Access to Architecture Graphs - Cloud Architect Design Tools - Alibaba Cloud - Cloud Architect Design Tools

Note

This API has been deprecated. We recommend migrating to BPStudio(2021-09-31) - GetApplication for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Operation description

Warning This API operation is deprecated. Access authorization for application images is included in the properties of the GetApplication response.

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

bpstudio:GetToken

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzhfgmw4e6fwq

Response elements

Element	Type	Description	Example
	object
Message	string	The error message.	Success
RequestId	string	The request ID.	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	object	The authorization information.
SecurityToken	string	The token used to access Object Storage Service (OSS).	ABCD
Endpoint	string	The endpoint of OSS.	https://oss-cn-beijing.aliyuncs.com
AccessKeySecret	string	The AccessKey secret used to access OSS.	9NG*****K4X
AccessKeyId	string	The AccessKey ID used to access OSS.	STS.NTm*****8tu
Bucket	string	The OSS bucket where files are stored.	bucket-1
SnapshotBucket	string	The OSS bucket where snapshots are stored.	bucket-2
UploadPrefix	string		/12345/
Code	string	The status code.	200

Examples

Success response

JSON format

{
  "Message": "Success",
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": {
    "SecurityToken": "ABCD",
    "Endpoint": "https://oss-cn-beijing.aliyuncs.com",
    "AccessKeySecret": "9NG*****K4X",
    "AccessKeyId": "STS.NTm*****8tu",
    "Bucket": "bucket-1",
    "SnapshotBucket": "bucket-2",
    "UploadPrefix": "/12345/"
  },
  "Code": "200"
}

Error codes

HTTP status code	Error code	Error message	Description
200	Success	The transaction is successful.
500	ServiceError	A server error occurred. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.