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

Realiza uma consulta paginada de instâncias de ambiente de desenvolvimento pessoal. Ao invocar esta operação, utilize o endpoint do DataWorks correspondente à região do workspace de destino.

Descrição da operação

Realiza uma consulta paginada de instâncias de ambiente de desenvolvimento pessoal (ServerIDE). Você pode filtrar as instâncias por workspace, grupo de recursos, palavra-chave, proprietário e subtipo de instância.

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
ProjectId	integer	Não	O ID do workspace do DataWorks.	10000
ResourceGroupId	string	Não	O identificador do grupo de recursos do DataWorks. Você pode usar o ID numérico do grupo de recursos ou o identificador completo no formato Serverless_res_group_{tenantId}_{resgId}.	Serverless_res_group_123456789012345_9876543210****
Keyword	string	Não	A palavra-chave usada para corresponder ao ID da instância ou ao nome da instância.	notebook_dev
RelatedUserId	string	Não	O ID da conta do usuário que possui a instância.	20933221576142****
SubType	string	Não	O subtipo da instância. Valores válidos: PERSONAL_DEV: ambiente de desenvolvimento pessoal DATA_AGENT: Data Agent	PERSONAL_DEV
PageNumber	integer	Não	O número da página. As páginas começam em 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página.	10
MaxResults	integer	Não	O número máximo de entradas a serem retornadas para uma única solicitação.	20
NextToken	string	Não	O token de paginação usado para continuar a consulta. Você não precisa especificar este parâmetro na primeira chamada.	CAESG****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	E7D55162-4489-1619-AAF5-3F97D5FCA948
PagingInfo	object	As informações de paginação.
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas retornadas na página atual.	10
TotalCount	integer	O número total de entradas que atendem às condições de consulta.	3
Instances	array<object>	A lista de instâncias de ambiente de desenvolvimento pessoal.
	array<object>	As informações sobre uma instância de ambiente de desenvolvimento pessoal.
InstanceId	string	O ID da instância de ambiente de desenvolvimento pessoal.	699573
InstanceName	string	O nome da instância de ambiente de desenvolvimento pessoal.	notebook_dev
Status	string	O status da instância. Valores válidos: Creating, Starting, Running, Stopping, Stopped, Updating, Deleting, DELETED, Failed, Arrearage, Saving, SaveFailed e Saved.	Running
ResourceGroupId	integer	O ID numérico interno do grupo de recursos.	9876543210
ResourceGroupName	string	O nome do grupo de recursos.	serverless_group
Cu	integer	O número de unidades de computação (CUs) usadas pela instância.	10
ProjectId	integer	O ID do workspace do DataWorks.	10000
ProjectName	string	O nome do workspace do DataWorks.	example_project
ImageId	string	O ID da imagem usada pela instância.	System_serveride_notebook_20240822
ImageName	string	O nome da imagem.	serveride_notebook
ImageUrl	string	A URL da imagem.	registry.cn-hangzhou.aliyuncs.com/example/serveride:latest
OwnerId	string	O ID da conta do usuário que possui a instância.	20933221576142****
FailReason	string	O motivo pelo qual a instância entrou no estado de falha.	ImagePullBackOff
CreateTime	integer	A hora em que a instância foi criada. O valor é um carimbo de data/hora UNIX em milissegundos.	1756000000000
UpdateTime	integer	A hora em que a instância foi atualizada pela última vez. O valor é um carimbo de data/hora UNIX em milissegundos.	1756003600000
UserVpc	object	A configuração de virtual private cloud (VPC) usada pela instância.
SecurityGroupId	string	O ID do grupo de segurança.	sg-bp1****
VSwitchId	string	O ID do vSwitch.	vsw-bp1****
VpcId	string	O ID da VPC.	vpc-bp1****
ForwardInfos	array<object>	A lista de configurações de encaminhamento de porta.
	object	A configuração de encaminhamento de porta.
AccessType	array	A lista de tipos de acesso.
	string	O tipo de acesso. Valores válidos: intranet: rede interna internet: Internet	intranet
ContainerName	string	O nome do contêiner de destino.	dsw-notebook
EipAllocationId	string	O ID da instância do endereço elastic IP (EIP).	eip-bp1****
Enable	boolean	Especifica se a configuração de encaminhamento de porta está ativada.
ExternalPort	string	A porta pública mapeada.	1024
ForwardPort	string	A porta de destino no contêiner da instância.	22
Name	string	O nome da configuração de encaminhamento de porta.	ssh
NatGatewayId	string	O ID do NAT gateway.	ngw-bp1****
SSHPublicKey	string	A chave pública usada para acesso SSH.	ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****
Datasets	array<object>	Os conjuntos de dados montados na instância.
	object	A configuração de montagem do conjunto de dados.
Identifier	string	O identificador do conjunto de dados.	d-vsqjvs****rp5l206u
Version	integer	O número da versão do conjunto de dados.	1
MountPath	string	O caminho de montagem do conjunto de dados na instância.	/mnt/data
ReadOnly	boolean	Especifica se o conjunto de dados é montado no modo somente leitura.
ExtOptions	string	Os atributos de montagem personalizados do conjunto de dados. O conteúdo é passado como opções de montagem.	{"fs.oss.download.thread.concurrency":"10"}
Uri	string	O URI do diretório do serviço de armazenamento usado para montagem direta.	oss://example-bucket/data/
CredentialConfig	object	A configuração de injeção de credenciais da instância. Depois que esse recurso é ativado, você pode usar a cadeia de funções padrão do Resource Access Management (RAM) ou especificar uma função RAM personalizada.
Enable	boolean	Especifica se a injeção de credenciais está ativada.
AliyunEnvRoleKey	string	A chave da função da variável de ambiente.	0
Configs	array<object>	As configurações de credenciais.
	array<object>	A configuração de credenciais.
Key	string	A chave identificadora da configuração de credenciais.	0
Type	string	O tipo de configuração de credenciais. Valores válidos: Role: assunção de função única RoleChain: assunção de cadeia de funções	RoleChain
Roles	array<object>	As funções na configuração de credenciais.
	array<object>	A configuração de assunção de função.
AssumeRoleFor	string	O ID da conta Alibaba Cloud da entidade à qual a função assumida pertence.	123456789012****
Policy	string	A política usada para restringir ainda mais as permissões da função.	{}
RoleArn	string	O Alibaba Cloud Resource Name (ARN) da função RAM.	acs:ram::123456789012****:role/DataWorksRole
RoleType	string	O tipo de assunção de função. Valores válidos: service: assumida por um serviço user: assumida por um usuário	service
UserInfo	object	As informações sobre o usuário proxy.
AccessKeyId	string	O AccessKey ID temporário usado para injeção de credenciais.	STS.N*********7
Id	string	O ID da conta do usuário proxy.	20933221576142****
SecurityToken	string	O token de segurança temporário usado para injeção de credenciais.	DFE32G*******
Type	string	O tipo de usuário. Valores válidos: customer: conta Alibaba Cloud sub: usuário RAM AssumedRoleUser: função RAM	sub
MaxResults	integer	O número máximo de entradas retornadas na resposta atual.	20
NextToken	string	O token de paginação para a próxima página. Um valor vazio indica que não há mais resultados disponíveis.	CAESG****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 3,
    "Instances": [
      {
        "InstanceId": "699573",
        "InstanceName": "notebook_dev",
        "Status": "Running",
        "ResourceGroupId": 9876543210,
        "ResourceGroupName": "serverless_group",
        "Cu": 10,
        "ProjectId": 10000,
        "ProjectName": "example_project",
        "ImageId": "System_serveride_notebook_20240822",
        "ImageName": "serveride_notebook",
        "ImageUrl": "registry.cn-hangzhou.aliyuncs.com/example/serveride:latest",
        "OwnerId": "20933221576142****",
        "FailReason": "ImagePullBackOff",
        "CreateTime": 1756000000000,
        "UpdateTime": 1756003600000,
        "UserVpc": {
          "SecurityGroupId": "sg-bp1****",
          "VSwitchId": "vsw-bp1****",
          "VpcId": "vpc-bp1****",
          "ForwardInfos": [
            {
              "AccessType": [
                "intranet"
              ],
              "ContainerName": "dsw-notebook",
              "EipAllocationId": "eip-bp1****",
              "Enable": false,
              "ExternalPort": "1024",
              "ForwardPort": "22",
              "Name": "ssh",
              "NatGatewayId": "ngw-bp1****",
              "SSHPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****"
            }
          ]
        },
        "Datasets": [
          {
            "Identifier": "d-vsqjvs****rp5l206u",
            "Version": 1,
            "MountPath": "/mnt/data",
            "ReadOnly": false,
            "ExtOptions": "{\"fs.oss.download.thread.concurrency\":\"10\"}",
            "Uri": "oss://example-bucket/data/"
          }
        ],
        "CredentialConfig": {
          "Enable": false,
          "AliyunEnvRoleKey": "0",
          "Configs": [
            {
              "Key": "0",
              "Type": "RoleChain",
              "Roles": [
                {
                  "AssumeRoleFor": "123456789012****",
                  "Policy": "{}",
                  "RoleArn": "acs:ram::123456789012****:role/DataWorksRole",
                  "RoleType": "service",
                  "UserInfo": {
                    "AccessKeyId": "STS.N*********7",
                    "Id": "20933221576142****",
                    "SecurityToken": "DFE32G*******",
                    "Type": "sub"
                  }
                }
              ]
            }
          ]
        }
      }
    ]
  },
  "MaxResults": 20,
  "NextToken": "CAESG****"
}

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.