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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListProjects	Operação a ser executada. Defina o valor como ListProjects.
PageNumber	Integer	Sim	1	Número da página.
PageSize	Integer	Não	10	Quantidade de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
ResourceManagerResourceGroupId	String	Não	rg-acfmzbn7pti3zfa	ID do grupo de recursos.
Tags	Array	Não		Tags.
Key	String	Não	Env	Chave da tag.
Value	String	Não	Test	Valor da tag.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	20658801***	ID da solicitação.
PageResult	Object		Resultados retornados.
PageNumber	Integer	1	Número da página.
PageSize	Integer	10	Quantidade de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
TotalCount	Integer	123	Total de entradas retornadas.
ProjectList	Array of Project		Workspaces do DataWorks retornados.
ProjectStatusCode	String	AVAILABLE	Código de status do workspace. Valores válidos: AVAILABLE: 0, indica que o workspace está em execução normal. DELETED: 1, indica que o workspace foi excluído. INITIALIZING: 2, indica que o workspace está sendo inicializado. INIT_FAILED: 3, indica falha na inicialização do workspace. FORBIDDEN: 4, indica que o workspace foi desativado manualmente. DELETING: 5, indica que o workspace está sendo excluído. DEL_FAILED: 6, indica falha na exclusão do workspace. FROZEN: 7, indica que o workspace está congelado devido a pagamentos pendentes. UPDATING: 8, indica que o workspace está sendo atualizado. Ao associar um mecanismo de computação ao workspace, o sistema o inicializa e atualiza o workspace. UPDATE_FAILED: 9, indica falha na atualização do workspace.
ProjectStatus	Integer	0	Status do workspace. Valores válidos: 0: AVAILABLE, indica que o workspace está em execução normal. 1: DELETED, indica que o workspace foi excluído. 2: INITIALIZING, indica que o workspace está sendo inicializado. 3: INIT_FAILED, indica falha na inicialização do workspace. 4: FORBIDDEN, indica que o workspace foi desativado manualmente. 5: DELETING, indica que o workspace está sendo excluído. 6: DEL_FAILED, indica falha na exclusão do workspace. 7: FROZEN, indica que o workspace está congelado devido a pagamentos pendentes. 8: UPDATING, indica que o workspace está sendo atualizado. Ao associar um mecanismo de computação ao workspace, o sistema o inicializa e atualiza o workspace. 9: UPDATE_FAILED, indica falha na atualização do workspace.
ProjectName	String	Test	Nome do workspace.
ProjectIdentifier	String	test	Identificador do workspace.
ProjectId	Long	1212	ID do workspace.
ProjectDescription	String	Test	Descrição do workspace.
ProjectOwnerBaseId	String	122222	ID do usuário proprietário do workspace.
ResourceManagerResourceGroupId	String	rg-acfmzbn7pti3zfa	ID do grupo de recursos.
Tags	Array of Tag		Tags.
Key	String	Env	Chave da tag.
Value	String	Test	Valor da tag.
DisableDevelopment	Boolean	true	Indica se a função Development está desativada. Valores válidos: false: ativada true: desativada Valor padrão: false
UseProxyOdpsAccount	Boolean	true	Indica se uma conta proxy é usada para acessar o mecanismo de computação MaxCompute associado ao workspace.
TablePrivacyMode	Integer	1	Indica se as tabelas do MaxCompute no workspace são visíveis aos usuários do tenant. Valores válidos: 0: invisível 1: visível
IsDefault	Integer	1	Indica se o workspace é padrão. Valores válidos: 1: É um workspace padrão. 0: Não é um workspace padrão.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListProjects
&PageNumber=1
&PageSize=10
&ResourceManagerResourceGroupId=rg-acfmzbn7pti3zfa
&Tags=[{"Key":"Env","Value":"Test"}]
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListProjectsResponse>
    <RequestId>20658801***</RequestId>
    <PageResult>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>123</TotalCount>
        <ProjectList>
            <ProjectStatusCode>AVAILABLE</ProjectStatusCode>
            <ProjectStatus>0</ProjectStatus>
            <ProjectName>Test</ProjectName>
            <ProjectIdentifier>test</ProjectIdentifier>
            <ProjectId>1212</ProjectId>
            <ProjectDescription>Test</ProjectDescription>
            <ProjectOwnerBaseId>122222</ProjectOwnerBaseId>
            <ResourceManagerResourceGroupId>rg-acfmzbn7pti3zfa</ResourceManagerResourceGroupId>
            <Tags>
                <Key>Env</Key>
                <Value>Test</Value>
            </Tags>
            <DisableDevelopment>true</DisableDevelopment>
            <UseProxyOdpsAccount>true</UseProxyOdpsAccount>
            <TablePrivacyMode>1</TablePrivacyMode>
            <IsDefault>1</IsDefault>
        </ProjectList>
    </PageResult>
</ListProjectsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "20658801***",
  "PageResult" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 123,
    "ProjectList" : {
      "ProjectStatusCode" : "AVAILABLE",
      "ProjectStatus" : 0,
      "ProjectName" : "Test",
      "ProjectIdentifier" : "test",
      "ProjectId" : 1212,
      "ProjectDescription" : "Test",
      "ProjectOwnerBaseId" : "122222",
      "ResourceManagerResourceGroupId" : "rg-acfmzbn7pti3zfa",
      "Tags" : {
        "Key" : "Env",
        "Value" : "Test"
      },
      "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.	A source de dados especificada não existe.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	O workspace especificado não existe.
400	Invalid.Tenant.UserAlreadyInProject	The user already exists in the project.	O usuário a ser adicionado já está no workspace.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	O usuário não foi adicionado ao workspace.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	O usuário não é o proprietário ou administrador do workspace.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	O usuário não pertence ao tenant.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.