Queries a list of DataWorks workspaces of the tenant to which your account belongs.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:ListProjects | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Ids | array | No | The IDs of the DataWorks workspaces. | |
| long | No | The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the ID. | 123456 | |
| Names | array | No | The names of the DataWorks workspaces. | |
| string | No | The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the name. | sora_finance | |
| AliyunResourceGroupId | string | No | The ID of the Alibaba Cloud resource group to which the workspaces belong. You can log on to the Resource Management console and go to the Resource Group page to query the ID. This parameter is used to query the information about workspaces that belong to a specific resource group. | rg-acfmzbn7pti3zff |
| Status | string | No | The status of the workspaces. Valid values:
| Available |
| DevEnvironmentEnabled | boolean | No | Specifies whether the development environment is enabled. Valid values:
| true |
| DevRoleDisabled | boolean | No | Specifies whether the Develop role is disabled. Valid values:
| false |
| PaiTaskEnabled | boolean | No | Specifies whether scheduling of Platform for AI (PAI) tasks is enabled. Valid values:
| true |
| AliyunResourceTags | array<object> | No | The tags. | |
| object | No | The tag. You can log on to the Resource Management console and go to the Tag page to query the tag key and tag value. | ||
| Key | string | No | The tag key. | batch |
| Value | string | No | The tag value. | blue |
| PageNumber | integer | No | The page number. | 1 |
| PageSize | integer | No | The number of entries per page. Default value: 10. Maximum value: 100. | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "6D24AD9A-652F-59E2-AC1F-05029300F8A4",
"PagingInfo": {
"PageSize": 1,
"PageNumber": 10,
"TotalCount": 100,
"Projects": [
{
"Id": 123456,
"Name": "sora_finance",
"DisplayName": "Sora financial analysis\n",
"Description": "Financial analysis group project data development",
"Owner": 123532153125,
"AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
"Status": "Available",
"PaiTaskEnabled": true,
"DevEnvironmentEnabled": true,
"DevRoleDisabled": false,
"AliyunResourceTags": [
{
"Key": "batch",
"Value": "blue"
}
]
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|