GetServerIdeInstance - DataWorks - Centro de documentación de Alibaba Cloud

Consulta los detalles de una instancia de entorno de desarrollo personal especificada.

Descripción de la operación

Consulta la información básica, el estado de ejecución, la imagen, la red, el conjunto de datos y las configuraciones de credenciales de una instancia de entorno de desarrollo personal (ServerIDE) especificada.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia de entorno de desarrollo personal. Puede llamar a ListServerIdeInstances para obtener el ID.	699573

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
RequestId	string	El ID de la solicitud.	E7D55162-4489-1619-AAF5-3F97D5FCA948
Instance	object	Los detalles de la instancia de entorno de desarrollo personal.
InstanceId	string	El ID de la instancia de entorno de desarrollo personal.	699573
InstanceName	string	El nombre de la instancia de entorno de desarrollo personal.	notebook_dev
Status	string	El estado de la instancia. Valores válidos: Creating, Starting, Running, Stopping, Stopped, Updating, Deleting, DELETED, Failed, Arrearage, Saving, SaveFailed y Saved.	Running
ResourceGroupId	integer	El ID numérico interno del grupo de recursos.	9876543210
ResourceGroupName	string	El nombre del grupo de recursos.	serverless_group
Cu	integer	El número de CU utilizadas por la instancia.	10
ProjectId	integer	El ID del espacio de trabajo de DataWorks.	10000
ProjectName	string	El nombre del espacio de trabajo de DataWorks.	example_project
ImageId	string	El ID de la imagen utilizada por la instancia.	System_serveride_notebook_20240822
ImageName	string	El nombre de la imagen.	serveride_notebook
ImageUrl	string	La URL de la imagen.	registry.cn-hangzhou.aliyuncs.com/example/serveride:latest
OwnerId	string	El ID de cuenta del usuario propietario de la instancia.	20933221576142****
FailReason	string	El motivo por el cual la instancia entró en estado fallido.	ImagePullBackOff
CreateTime	integer	La hora en que se creó la instancia. Este valor es una marca de tiempo UNIX en milisegundos.	1756000000000
UpdateTime	integer	La hora en que se actualizó la instancia por última vez. Este valor es una marca de tiempo UNIX en milisegundos.	1756003600000
UserVpc	object	La configuración de VPC utilizada por la instancia.
SecurityGroupId	string	El ID del security group.	sg-bp1****
VSwitchId	string	El ID del vSwitch.	vsw-bp1****
VpcId	string	El ID de la VPC.	vpc-bp1****
ForwardInfos	array<object>	La lista de configuraciones de reenvío de puertos.
	object	La configuración de reenvío de puertos.
AccessType	array	La lista de tipos de acceso.
	string	El tipo de acceso. Valores válidos: intranet (red interna) e internet (red pública).	intranet
ContainerName	string	El nombre del contenedor de destino.	dsw-notebook
EipAllocationId	string	El ID de instancia de la dirección IP elástica (EIP) pública.	eip-bp1****
Enable	boolean	Indica si esta configuración de reenvío de puertos está habilitada.
ExternalPort	string	El puerto público asignado.	1024
ForwardPort	string	El puerto de destino dentro del contenedor de la instancia.	22
Name	string	El nombre de la configuración de reenvío de puertos.	ssh
NatGatewayId	string	El ID de la puerta de enlace NAT.	ngw-bp1****
SSHPublicKey	string	La clave pública utilizada para el acceso SSH.	ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****
Datasets	array<object>	La lista de conjuntos de datos montados en la instancia.
	object	La configuración de montaje del conjunto de datos.
Identifier	string	El identificador del conjunto de datos.	d-vsqjvs****rp5l206u
Version	integer	El número de versión del conjunto de datos.	1
MountPath	string	La ruta de montaje del conjunto de datos en la instancia.	/mnt/data
ReadOnly	boolean	Indica si el conjunto de datos se monta en modo de solo lectura.
ExtOptions	string	Las propiedades de montaje personalizadas del conjunto de datos. El contenido se pasa como opciones de montaje.	{"fs.oss.download.thread.concurrency":"10"}
Uri	string	La URI del directorio del servicio de almacenamiento utilizada para el montaje directo.	oss://example-bucket/data/
CredentialConfig	object	La configuración de inyección de credenciales de la instancia. Después de habilitar esta función, puede utilizar la cadena de roles RAM predeterminada o especificar un rol RAM personalizado.
Enable	boolean	Indica si la inyección de credenciales está habilitada.
AliyunEnvRoleKey	string	La clave de rol de variable de entorno.	0
Configs	array<object>	La lista de configuraciones de credenciales.
	array<object>	La configuración de credenciales.
Key	string	La clave identificadora de la configuración de credenciales.	0
Type	string	El tipo de configuración de credenciales. Valores válidos: Role (asunción de rol único) y RoleChain (asunción de cadena de roles).	RoleChain
Roles	array<object>	La lista de roles en la configuración de credenciales.
	array<object>	La configuración de asunción de rol.
AssumeRoleFor	string	El ID de cuenta de Alibaba Cloud de la entidad principal propietaria del rol asumido.	123456789012****
Policy	string	La política utilizada para restringir aún más los permisos del rol.	{}
RoleArn	string	El ARN del rol RAM.	acs:ram::123456789012****:role/DataWorksRole
RoleType	string	El tipo de asunción de rol. Valores válidos: service (asumido por un servicio) y user (asumido por un usuario).	service
UserInfo	object	La información del usuario representado.
AccessKeyId	string	El ID de AccessKey temporal utilizado para la inyección de credenciales.	STS.N*********7
Id	string	El ID de cuenta del usuario representado.	20933221576142****
SecurityToken	string	El token de seguridad temporal utilizado para la inyección de credenciales.	DFE32G*******
Type	string	El tipo de usuario. Valores válidos: customer (cuenta de Alibaba Cloud), sub (usuario RAM) y AssumedRoleUser (rol RAM).	sub

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.