ListProjects - DataWorks: Central de Documentação do Alibaba Cloud

Consulta uma lista de workspaces do DataWorks do tenant ao qual um usuário pertence.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página. Valores válidos: 1 a 100.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmzbn7pt****
Tags	array<object>	Não	As tags a serem adicionadas ao workspace.
	object	Não
Key	string	Não	A chave da tag N a ser adicionada ao workspace.	key
Value	string	Não	O valor da tag N a ser adicionado ao workspace.	value

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	20658801****
PageResult	object	Os resultados retornados.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
TotalCount	integer	O número total de entradas retornadas.	68
ProjectList	array<object>	Os workspaces do DataWorks.
	array<object>
ProjectStatusCode	string	The status code of the workspace. Valid values: AVAILABLE: 0, which indicates that the workspace is running as expected. DELETED: 1, which indicates that the workspace is deleted. INITIALIZING: 2, which indicates that the workspace is being initialized. INIT_FAILED: 3, which indicates that the workspace fails to be initialized. FORBIDDEN: 4, which indicates that the workspace is manually disabled. DELETING: 5, which indicates that the workspace is being deleted. DEL_FAILED: 6, which indicates that the workspace fails to be deleted. FROZEN: 7, which indicates that the workspace is frozen due to overdue payments. UPDATING: 8, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace. UPDATE_FAILED: 9, which indicates that the workspace fails to be updated.	AVAILABLE
ProjectStatus	integer	The status of the workspace. Valid values: 0: AVAILABLE, which indicates that the workspace is running as expected. 1: DELETED, which indicates that the workspace is deleted. 2: INITIALIZING, which indicates that the workspace is being initialized. 3: INIT_FAILED, which indicates that the workspace fails to be initialized. 4: FORBIDDEN, which indicates that the workspace is manually disabled. 5: DELETING, which indicates that the workspace is being deleted. 6: DEL_FAILED, which indicates that the workspace fails to be deleted. 7: FROZEN, which indicates that the workspace is frozen due to overdue payments. 8: UPDATING, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace. 9: UPDATE_FAILED, which indicates that the workspace fails to be updated.	0
ProjectName	string	The display name of the workspace.	test_project
ProjectIdentifier	string	The name of the workspace.	test_project
ProjectId	integer	The workspace ID.	466230
ProjectDescription	string	The description of the workspace.	test_describe
ProjectOwnerBaseId	string	The ID of the user used by the workspace owner.	13969939245****
ResourceManagerResourceGroupId	string	The resource group ID.	rg-acfmzbn7****
Tags	array<object>	The tags added to the workspace.
	object
Key	string	The key of tag N added to the workspace.	key
Value	string	The value of tag N added to the workspace.	value
DisableDevelopment	boolean	Indicates whether the Development role is disabled. Valid values: false: enabled true: disabled	true
UseProxyOdpsAccount	boolean	Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace. Valid values: false true	true
TablePrivacyMode	integer	Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values: 0: invisible 1: visible	1
IsDefault	integer	Indicates whether the workspace is a default workspace. Valid values: 1: The workspace is a default workspace. 0: The workspace is not a default workspace.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "20658801****",
  "PageResult": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 68,
    "ProjectList": [
      {
        "ProjectStatusCode": "AVAILABLE",
        "ProjectStatus": 0,
        "ProjectName": "test_project",
        "ProjectIdentifier": "test_project",
        "ProjectId": 466230,
        "ProjectDescription": "test_describe",
        "ProjectOwnerBaseId": "13969939245****",
        "ResourceManagerResourceGroupId": "rg-acfmzbn7****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "DisableDevelopment": true,
        "UseProxyOdpsAccount": true,
        "TablePrivacyMode": 1,
        "IsDefault": 1
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.