调用ListProjects,分页列出用户所在租户下的DataWorks工作空间列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListProjects |
要执行的操作。 |
PageNumber | Integer | 是 | 1 |
分页的页码。 |
RegionId | String | 是 | cn-shanghai |
DataWorks所在地域的ID。 |
PageSize | Integer | 否 | 10 |
每页显示的条数,默认为10条,最大100条。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageResult | Struct |
查询的结果。 |
|
PageNumber | Integer | 1 |
当前的页码。 |
PageSize | Integer | 10 |
每页显示的条数,默认为10条,最大100条。 |
ProjectList | Array of Project |
DataWorks工作空间的结果列表。 |
|
ProjectDescription | String | 测试空间 |
工作空间的详细描述信息。 |
ProjectId | Long | 1212 |
工作空间的ID。 |
ProjectIdentifier | String | test |
工作空间的编码。 |
ProjectName | String | 测试空间 |
工作空间的名称。 |
ProjectOwnerBaseId | String | 122222 |
工作空间所有者的用户ID。 |
ProjectStatus | Integer | 0 |
工作空间的状态。 |
ProjectStatusCode | String | AVAILABLE |
工作空间的状态码。 |
TotalCount | Integer | 123 |
结果的总条数。 |
RequestId | String | 20658801*** |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListProjects
&PageNumber=1
&RegionId=cn-shanghai
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>20658801***</RequestId>
<PageResult>
<TotalCount>123</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<ProjectList>
<ProjectIdentifier>test</ProjectIdentifier>
<ProjectOwnerBaseId>122222</ProjectOwnerBaseId>
<ProjectStatus>0</ProjectStatus>
<ProjectStatusCode>AVAILABLE</ProjectStatusCode>
<ProjectName>测试空间</ProjectName>
<ProjectId>1212</ProjectId>
<ProjectDescription>测试空间</ProjectDescription>
</ProjectList>
</PageResult>
JSON
格式
{
"RequestId":"20658801***",
"PageResult":{
"TotalCount":"123",
"PageSize":"10",
"PageNumber":"1",
"ProjectList":[
{
"ProjectIdentifier":"test",
"ProjectOwnerBaseId":"122222",
"ProjectStatus":"0",
"ProjectStatusCode":"AVAILABLE",
"ProjectName":"测试空间",
"ProjectId":"1212",
"ProjectDescription":"测试空间"
}
]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Invalid.Tenant.ConnectionNotExists | The connection does not exist. | 数据源不存在。 |
400 | Invalid.Tenant.ProjectNotExists | The project does not exist. | 项目不存在。 |
400 | Invalid.Tenant.UserAlreadyInProject | The user already exists in the project. | 待添加用户已经存在于工作空间中。 |
403 | Invalid.Tenant.UserIsNotProjectOwnerOrAdmin | The user is not a project administrator or owner. | 用户不是项目负责人或者项目管理员。 |
400 | Invalid.Tenant.UserNotInProject | The user is not in the project. | 用户不在项目中。 |
403 | Invalid.Tenant.UserNotInTenant | The user is not in tenant. | 用户不在租户中。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交