GetInstance - Data Management - Centro de documentación de Alibaba Cloud

Obtiene los detalles de una instancia 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

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dms:GetInstance

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Llame a la operación GetUserActiveTenant para obtener este valor.	2***
Host	string	Sí	El endpoint de la instancia. Llame a la operación ListInstances para obtener este valor.	172.17.XXX.XXX
Port	integer	Sí	El puerto de la instancia. Llame a la operación ListInstances para obtener este valor.	5432
Sid	string	No	El SID de la instancia. Llame a la operación ListInstances para obtener este valor.	test
RealLoginUserUid	string	No	Este parámetro está reservado.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	F6C80B69-3203-56AC-8021-18BA72A6F4E1
Instance	object	Detalles de la instancia.
VpcId	string	El ID de la VPC a la que pertenece la instancia.	vpc-o6wrloqsdqc9io3mg****
DatabaseUser	string	El nombre de usuario utilizado para iniciar sesión en la instancia.	dbuser
DbaId	string	El ID del administrador de bases de datos (DBA) de la instancia.	29****
UseDsql	integer	Indica si la consulta entre bases de datos está habilitada para la instancia. Valores válidos: 0: deshabilitado 1: habilitado	0
Port	integer	El puerto utilizado para conectarse a la instancia.	5432
EcsInstanceId	string	El ID de la instancia de ECS en la que se despliega la instancia de base de datos.	i-bp124ldpklqz59y3****
EnvType	string	El tipo de entorno al que pertenece la instancia. Valores válidos: product: entorno de producción dev: entorno de desarrollo pre: entorno de prelanzamiento test: entorno de pruebas sit: entorno de prueba de integración del sistema (SIT) uat: entorno de prueba de aceptación del usuario (UAT) pet: entorno de prueba de rendimiento stag: entorno de staging	test
Sid	string	El ID del sistema (SID) de la instancia.	test
OwnerIdList	object	Los ID de los propietarios de la instancia.
OwnerIds	array	Los ID de usuario de los propietarios de la instancia.
	string	El ID de usuario de un propietario de la instancia.	10****
SafeRuleId	string	El ID del conjunto de reglas de seguridad para la instancia.	3****
OwnerNameList	object	Los apodos de los propietarios de la instancia.
OwnerNames	array	Los apodos de los propietarios de la instancia.
	string	El apodo de un propietario de la instancia.	yang_test
DbaNickName	string	El apodo del DBA de la instancia.	dbaname
QueryTimeout	integer	El tiempo de espera para consultar datos en la instancia. Unidad: segundos.	7200
InstanceSource	string	El origen de la instancia.	ECS_OWN
Host	string	El endpoint utilizado para conectarse a la instancia.	192.168.XXX.XXX
State	string	El estado de la instancia. Valores válidos: NORMAL: La instancia se ejecuta con normalidad. DISABLE: La instancia está deshabilitada.	NORMAL
DataLinkName	string	El nombre del enlace de datos para la instancia.	test
ExportTimeout	integer	El tiempo de espera para exportar datos desde la instancia. Unidad: segundos.	86400
InstanceId	string	El ID de la instancia.	188****
InstanceType	string	El tipo de base de datos.	postgresql
DatabasePassword	string	La contraseña que corresponde al nombre de usuario.	******
InstanceAlias	string	El alias de la instancia.	测试
DdlOnline	integer	Indica si el cambio de esquema sin bloqueo está habilitado para la instancia.	0
EcsRegion	string	La región donde reside la instancia.	cn-beijing
StandardGroup	object	El modo de control de la instancia.
GroupName	string	El nombre del conjunto de reglas de seguridad que corresponde al modo de control.	自由操作
GroupMode	string	El modo de control. Valores válidos: COMMON: Colaboración de seguridad NONE_CONTROL: Gestión flexible STABLE: Cambio estable	NONE_CONTROL
SellSitd	string	Indica si la protección de datos confidenciales está habilitada. Valores válidos: true: habilitado false: deshabilitado	false
SellTrust	string	Este parámetro está reservado.
ErrorCode	string	El código de error devuelto.	UnknownError
ErrorMessage	string	El mensaje de error devuelto.	UnknownError
Success	boolean	Indica si la solicitud fue exitosa. Valores válidos: true false	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance": {
    "VpcId": "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser": "dbuser",
    "DbaId": "29****",
    "UseDsql": 0,
    "Port": 5432,
    "EcsInstanceId": "i-bp124ldpklqz59y3****",
    "EnvType": "test",
    "Sid": "test",
    "OwnerIdList": {
      "OwnerIds": [
        "10****"
      ]
    },
    "SafeRuleId": "3****",
    "OwnerNameList": {
      "OwnerNames": [
        "yang_test"
      ]
    },
    "DbaNickName": "dbaname",
    "QueryTimeout": 7200,
    "InstanceSource": "ECS_OWN",
    "Host": "192.168.XXX.XXX",
    "State": "NORMAL",
    "DataLinkName": "test",
    "ExportTimeout": 86400,
    "InstanceId": "188****",
    "InstanceType": "postgresql",
    "DatabasePassword": "******",
    "InstanceAlias": "Test",
    "DdlOnline": 0,
    "EcsRegion": "cn-beijing",
    "StandardGroup": {
      "GroupName": "Free operation",
      "GroupMode": "NONE_CONTROL"
    },
    "SellSitd": "false",
    "SellTrust": ""
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

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.