Queries a list of DataWorks workspaces of the tenant to which a user 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:
- The required resource types are displayed in bold characters.
- 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 | get | *Project acs:dataworks:{#regionId}:{#accountId}:workspace/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageNumber | integer | Yes | The page number. Valid values: 1 to 100. | 1 |
| PageSize | integer | No | The number of entries per page. Default value: 10. Maximum value: 100. | 10 |
| ResourceManagerResourceGroupId | string | No | The resource group ID. | rg-acfmzbn7pti3zfa |
| Tags | array<object> | No | The tags to add to the workspace. | |
| object | No | |||
| Key | string | No | The key of tag N to add to the workspace. | Env |
| Value | string | No | The value of tag N to add to the workspace. | Test |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "20658801***",
"PageResult": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 123,
"ProjectList": [
{
"ProjectStatusCode": "AVAILABLE",
"ProjectStatus": 0,
"ProjectName": "test_project",
"ProjectIdentifier": "test",
"ProjectId": 1212,
"ProjectDescription": "test_describe",
"ProjectOwnerBaseId": "122222",
"ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
"Tags": [
{
"Key": "Env",
"Value": "Test"
}
],
"DisableDevelopment": true,
"UseProxyOdpsAccount": true,
"TablePrivacyMode": 1,
"IsDefault": 1
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Invalid.Tenant.ConnectionNotExists | The connection does not exist. | The connection does not exist. |
| 400 | Invalid.Tenant.ProjectNotExists | The project does not exist. | The project does not exist. |
| 400 | Invalid.Tenant.UserAlreadyInProject | The user already exists in the project. | The user has already existed in project. |
| 400 | Invalid.Tenant.UserNotInProject | The user is not in the project. | The user is not in the project. |
| 403 | Invalid.Tenant.UserIsNotProjectOwnerOrAdmin | The user is not a project administrator or owner. | The user is not a project administrator or owner. |
| 403 | Invalid.Tenant.UserNotInTenant | The user is not in tenant. | The user is not in tenant. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2022-10-31 | API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |