GetWorkspaceCode-阿里云帮助中心

Operation description

Obtains the resource configuration limit information and the instance purchase status of the workspace.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID.	12****
Path	string	Yes	The code file path: /Workspace/code/test.py Request path.	/Workspace/code/default/test.ipynb
Iac	string	No	If the file is a JSON file and Iac is set to true, the returned content is converted from JSON format to YAML format.	false

Response elements

Element	Type	Description	Example
	object	Schema of Response
Message	string	The error message returned when the request fails.	This record is being collected, please wait for a moment.
Data	string	The file content.	log info
RequestId	string	The request ID.	E0D21075-CD3E-4D98-8264-FD8AD04A63B6
HttpStatusCode	integer	The HTTP status code.	200
ErrorCode	string	The error code.	UnknownError
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Message": "This record is being collected, please wait for a moment.",
  "Data": "log info",
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "HttpStatusCode": 200,
  "ErrorCode": "UnknownError",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.