Consulta os detalhes de uma instância especificada de ambiente de desenvolvimento pessoal.
Descrição da operação
Consulta as informações básicas, o status de execução, a imagem, a rede, o conjunto de dados e as configurações de credenciais de uma instância especificada de ambiente de desenvolvimento pessoal (ServerIDE).
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| InstanceId |
string |
Sim |
O ID da instância do ambiente de desenvolvimento pessoal. Você pode chamar ListServerIdeInstances para obter o ID. |
699573 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
A resposta. |
||
| RequestId |
string |
O ID da solicitação. |
E7D55162-4489-1619-AAF5-3F97D5FCA948 |
| Instance |
object |
Os detalhes da instância do ambiente de desenvolvimento pessoal. |
|
| InstanceId |
string |
O ID da instância do ambiente de desenvolvimento pessoal. |
699573 |
| InstanceName |
string |
O nome da instância do 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 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 proprietário da 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. Este valor é um timestamp UNIX em milissegundos. |
1756000000000 |
| UpdateTime |
integer |
A hora em que a instância foi atualizada pela última vez. Este valor é um timestamp UNIX em milissegundos. |
1756003600000 |
| UserVpc |
object |
A configuração de 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) e internet (rede pública). |
intranet |
|
| ContainerName |
string |
O nome do contêiner de destino. |
dsw-notebook |
| EipAllocationId |
string |
O ID da instância do Elastic IP Address (EIP) público. |
eip-bp1**** |
| Enable |
boolean |
Indica se esta configuração de encaminhamento de porta está ativada. |
|
| ExternalPort |
string |
A porta pública mapeada. |
1024 |
| ForwardPort |
string |
A porta de destino dentro do contêiner da instância. |
22 |
| Name |
string |
O nome da configuração de encaminhamento de porta. |
ssh |
| NatGatewayId |
string |
O ID do gateway NAT. |
ngw-bp1**** |
| SSHPublicKey |
string |
A chave pública usada para acesso SSH. |
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ**** |
| Datasets |
array<object> |
A lista de 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 |
Indica se o conjunto de dados está montado no modo somente leitura. |
|
| ExtOptions |
string |
As propriedades personalizadas de montagem 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. Após a ativação deste recurso, você pode usar a cadeia de funções RAM padrão ou especificar uma função RAM personalizada. |
|
| Enable |
boolean |
Indica se a injeção de credenciais está ativada. |
|
| AliyunEnvRoleKey |
string |
A chave da função da variável de ambiente. |
0 |
| Configs |
array<object> |
A lista de 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) e RoleChain (assunção de cadeia de funções). |
RoleChain |
| Roles |
array<object> |
A lista de 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 do principal que possui a função assumida. |
123456789012**** |
| Policy |
string |
A política usada para restringir ainda mais as permissões da função. |
{} |
| RoleArn |
string |
O ARN da função RAM. |
acs:ram::123456789012****:role/DataWorksRole |
| RoleType |
string |
O tipo de assunção de função. Valores válidos: service (assumido por um serviço) e user (assumido por um usuário). |
service |
| UserInfo |
object |
As informações do usuário representado. |
|
| AccessKeyId |
string |
O ID temporário da AccessKey usado para injeção de credenciais. |
STS.N*********7 |
| Id |
string |
O ID da conta do usuário representado. |
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) e AssumedRoleUser (função RAM). |
sub |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
"Instance": {
"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"
}
}
]
}
]
}
}
}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.