ListWorkspaces - Platform For AI: Central de Documentação do Alibaba Cloud

Obtém a lista de workspaces em uma região.

Descrição da operação

Use o parâmetro Option para especificar diferentes opções de consulta e obter diferentes informações relacionadas ao workspace.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

paiworkspace:ListWorkspaces

list

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET /api/v1/workspaces HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página da lista de workspaces. Valor mínimo: 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para uma consulta paginada. Valor padrão: 20.	20
SortBy	string	Não	O campo de ordenação para uma consulta paginada. Valor padrão: GmtCreateTime. Valores válidos: GmtCreateTime (padrão): ordena por hora de criação. GmtModifiedTime: ordena por hora de modificação.	GmtCreateTime
Order	string	Não	A ordem de classificação aplicada ao campo de ordenação especificado em uma consulta paginada. Valores válidos: ASC (padrão): ordem ascendente. DESC: ordem descendente.	ASC
WorkspaceName	string	Não	O nome do workspace.	abc
ModuleList	string	Não	A lista de módulos separados por vírgulas. Valor padrão: PAI.	PAI
Status	string	Não	O status do workspace. Valores válidos: ENABLED: normal. INITIALIZING: inicializando. FAILURE: falhou. DISABLED: desativado manualmente. FROZEN: congelado devido a pagamento em atraso. UPDATING: atualizando.	ENABLED
Option	string	Não	As opções de consulta. Valores válidos: GetWorkspaces (padrão): obtém a lista de workspaces e retorna Workspaces. GetResourceLimits: obtém os limites de recursos e retorna ResourceLimits.	GetWorkspaces
Verbose	boolean	Não	Especifica se deve exibir os detalhes do workspace. Valores válidos: false (padrão): não exibe detalhes. true: exibe detalhes.	true
Fields	string	Não	A lista de campos a serem retornados nos detalhes do workspace. Use este parâmetro para limitar as propriedades do workspace incluídas na resposta. Separe várias propriedades com vírgulas (,). Atualmente, apenas Id (ID do workspace) é suportado.	Id
WorkspaceIds	string	Não	A lista de IDs de workspace. Separe vários IDs de workspace com vírgulas (,).	123,234
ResourceGroupId	string	Não	O ID do grupo de recursos. Para obter informações sobre como visualizar o ID do grupo de recursos, consulte Visualizar informações básicas sobre um grupo de recursos.	rg-acfmwp7rky****
UserId	string	Não	O ID do usuário.	17*****1743

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
RequestId	string	O ID da solicitação.	8D7B2E70-F770-505B-A672-09F1D8F2EC1E
Workspaces	array<object>	A lista de detalhes dos workspaces. Esta lista é retornada quando Option é definido como GetWorkspaces.
	array<object>	Os detalhes do workspace.
WorkspaceId	string	O ID do workspace.	123
WorkspaceName	string	O nome do workspace.	workspace-example
GmtCreateTime	string	A hora em que o workspace foi criado. A hora segue o padrão ISO 8601 em UTC+0. Formato: yyyy-MM-ddTHH:mm:ss.SSSZ.	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	A hora em que o workspace foi modificado pela última vez. A hora segue o padrão ISO 8601 em UTC+0. Formato: yyyy-MM-ddTHH:mmZ.	2021-01-21T17:12:35.232Z
Description	string	A descrição do workspace.	workspace description example
Creator	string	O ID de usuário do criador.	122424353535
EnvTypes	array	A lista de ambientes incluídos no workspace.
	string	O ambiente incluído no workspace. Valores válidos: O modo simples inclui apenas o ambiente de produção (prod). O modo padrão inclui tanto o ambiente de desenvolvimento (dev) quanto o ambiente de produção (prod).	prod
Status	string	O status do workspace.	ENABLED
AdminNames	array	A lista de nomes de contas de administrador.
	string	O nome da conta de administrador.	demo_test@***.aliyunid.com
IsDefault	boolean	Indica se este é o workspace padrão.	false
ExtraInfos	object	As informações estendidas. Atualmente inclui TenantId, que representa o ID do tenant.	{"TenantId": "4286******98"}
resourceGroupId	string	O ID do grupo de recursos.	rg-acfmwp7rky****
DisplayName	string	O nome de exibição do workspace.	workspace-example
TotalCount	integer	O número total de workspaces que correspondem às condições de consulta.	1
ResourceLimits	object	Os tipos e limites de quantidade de recursos que um usuário pode ativar em um workspace. Esta lista é retornada quando Option é definido como GetResourceLimits. Tipos de recursos atualmente suportados: MaxCompute_share: MaxCompute pago conforme o uso. MaxCompute_isolate: MaxCompute por assinatura. DLC_share: DLC pago conforme o uso. PAI_isolate: PAI por assinatura. PAI_share: PAI pago conforme o uso. DataWorks_isolate: DataWorks por assinatura. DataWorks_share: DataWorks pago conforme o uso.	{ "MaxCompute_share": 1, "MaxCompute_isolate": 1, "DLC_share": 1 }

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "8D7B2E70-F770-505B-A672-09F1D8F2EC1E",
  "Workspaces": [
    {
      "WorkspaceId": "123",
      "WorkspaceName": "workspace-example",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
      "Description": "workspace description example",
      "Creator": "122424353535",
      "EnvTypes": [
        "prod"
      ],
      "Status": "ENABLED",
      "AdminNames": [
        "demo_test@***.aliyunid.com"
      ],
      "IsDefault": false,
      "ExtraInfos": {
        "TenantId": "4286******98"
      },
      "resourceGroupId": "rg-acfmwp7rky****",
      "DisplayName": "workspace-example"
    }
  ],
  "TotalCount": 1,
  "ResourceLimits": {
    "MaxCompute_share": 1,
    "MaxCompute_isolate": 1,
    "DLC_share": 1
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.