GetInstance - - Centro de documentación de Alibaba Cloud

Consulta los detalles de una instancia de base de datos.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetInstance	La operación que desea ejecutar. Establezca el valor en GetInstance.
Tid	Long	Sí	2***	El ID del inquilino. Llame a la operación GetUserActiveTenant para consultar el ID del inquilino.
Host	String	Sí	172.17.XXX.XXX	El endpoint de la instancia de base de datos. Llame a la operación ListInstances para consultar el endpoint.
Port	Integer	Sí	5432	El número de puerto utilizado para conectarse a la instancia de base de datos. Llame a la operación ListInstances para consultar el número de puerto.
Sid	String	No	test	El ID del sistema (SID) de la instancia de base de datos. Llame a la operación ListInstances para consultar el SID.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	F6C80B69-3203-56AC-8021-18BA72A6F4E1	El ID de la solicitud.
Instance	Object		Los detalles de la instancia de base de datos.
VpcId	String	vpc-o6wrloqsdqc9io3mg****	El ID de la nube privada virtual (VPC) a la que pertenece la instancia de base de datos.
DatabaseUser	String	dbuser	La cuenta utilizada para iniciar sesión en la instancia de base de datos.
DbaId	String	29****	El ID del administrador de bases de datos (DBA) de la instancia de base de datos.
UseDsql	Integer	0	Indica si la función de consulta entre bases de datos está habilitada para la instancia de base de datos. Valores válidos: 0: La función de consulta entre bases de datos está deshabilitada. 1: La función de consulta entre bases de datos está habilitada.
Port	Integer	5432	El número de puerto utilizado para conectarse a la instancia de base de datos.
EcsInstanceId	String	i-bp124ldpklqz59y3****	El ID de la instancia de Elastic Compute Service (ECS) donde se despliega la instancia de base de datos.
EnvType	String	test	El tipo de entorno donde se despliega la instancia de base de datos. 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 estrés stag: entorno de staging
Sid	String	test	El SID de la instancia de base de datos.
OwnerIdList	Array of String	10****	Los IDs de los propietarios de la instancia de base de datos.
SafeRuleId	String	3****	El ID del conjunto de reglas de seguridad de la instancia de base de datos.
OwnerNameList	Array of String	yang_test	Los apodos de los propietarios de la instancia de base de datos.
DbaNickName	String	dbaname	El apodo del DBA de la instancia de base de datos.
QueryTimeout	Integer	7200	El tiempo de espera para consultar datos en la instancia de base de datos.
InstanceSource	String	ECS_OWN	El origen de la instancia de base de datos.
Host	String	192.168.XXX.XXX	El endpoint utilizado para conectarse a la instancia de base de datos.
State	String	NORMAL	El estado de la instancia de base de datos. Valores válidos: NORMAL: La instancia es normal. DISABLE: La instancia está deshabilitada.
DataLinkName	String	test	El nombre del vínculo de base de datos de la instancia de base de datos.
ExportTimeout	Integer	86400	El tiempo de espera para exportar datos desde la instancia de base de datos.
InstanceId	String	188****	El ID de la instancia.
InstanceType	String	postgresql	El tipo de la instancia de base de datos.
DatabasePassword	String	******	La contraseña utilizada para iniciar sesión en la instancia de base de datos.
InstanceAlias	String	Test	El alias de la instancia de base de datos.
DdlOnline	Integer	0	Indica si la función de cambio de esquema sin bloqueo está habilitada para la instancia de base de datos.
EcsRegion	String	cn-beijing	El ID de la región donde reside la instancia de base de datos.
StandardGroup	Object		El modo de control de la instancia de base de datos.
GroupName	String	Flexible Management	El nombre de la regla de seguridad correspondiente al modo de control.
GroupMode	String	NONE_CONTROL	El tipo de modo de control. Valores válidos: COMMON: Colaboración de seguridad NONE_CONTROL: Gestión flexible STABLE: Cambio estable
SellSitd	String	false	Indica si la función de protección de datos sensibles está habilitada. Valores válidos: true: La función de protección de datos sensibles está habilitada. false: La función de protección de datos sensibles está deshabilitada.
ErrorCode	String	UnknownError	El código de error devuelto si la solicitud presenta errores.
ErrorMessage	String	UnknownError	El mensaje de error devuelto si la solicitud presenta errores.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.

Ejemplos

Solicitudes de ejemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=GetInstance
&Tid=1
&Host=172.17.XXX.XXX
&Port=5432
&Sid=test
&Common request parameters

Respuestas exitosas de ejemplo

Formato XML

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

<GetInstanceResponse>
    <RequestId>F6C80B69-3203-56AC-8021-18BA72A6F4E1</RequestId>
    <Instance>
        <Port>5432</Port>
        <DatabasePassword>******</DatabasePassword>
        <ExportTimeout>86400</ExportTimeout>
        <EnvType>test</EnvType>
        <DbaId>12****</DbaId>
        <InstanceAlias>Test</InstanceAlias>
        <EcsRegion>cn-beijing</EcsRegion>
        <InstanceType>postgresql</InstanceType>
        <QueryTimeout>7200</QueryTimeout>
        <DataLinkName>dbl_postgresql_2</DataLinkName>
        <SafeRuleId>3****</SafeRuleId>
        <SellSitd>false</SellSitd>
        <InstanceSource>ECS_OWN</InstanceSource>
        <StandardGroup>
            <GroupName>Flexible Management</GroupName>
            <GroupMode>NONE_CONTROL</GroupMode>
        </StandardGroup>
        <InstanceId>188****</InstanceId>
        <Host>172.17.XXX.XXX</Host>
        <DdlOnline>0</DdlOnline>
        <UseDsql>0</UseDsql>
        <EcsInstanceId>i-bp124ldpklqz59y3****</EcsInstanceId>
        <State>NORMAL</State>
        <DatabaseUser>postgres</DatabaseUser>
        <OwnerNameList>
            <OwnerNames>yang_test</OwnerNames>
        </OwnerNameList>
        <DbaNickName>dbaname</DbaNickName>
        <OwnerIdList>
            <OwnerIds>10****</OwnerIds>
        </OwnerIdList>
    </Instance>
    <Success>true</Success>
</GetInstanceResponse>

Formato JSON

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

{
  "RequestId" : "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance" : {
    "Port" : 5432,
    "DatabasePassword" : "******",
    "ExportTimeout" : 86400,
    "EnvType" : "test",
    "DbaId" : "12****",
    "InstanceAlias" : "Test",
    "EcsRegion" : "cn-beijing",
    "InstanceType" : "postgresql",
    "QueryTimeout" : 7200,
    "DataLinkName" : "dbl_postgresql_2",
    "SafeRuleId" : "3****",
    "SellSitd" : false,
    "InstanceSource" : "ECS_OWN",
    "StandardGroup" : {
      "GroupName" : "Flexible Management",
      "GroupMode" : "NONE_CONTROL"
    },
    "InstanceId" : "188****",
    "Host" : "172.17.XXX.XXX",
    "DdlOnline" : 0,
    "UseDsql" : "0",
    "EcsInstanceId" : "i-bp124ldpklqz59y3****",
    "State" : "NORMAL",
    "DatabaseUser" : "postgres",
    "OwnerNameList" : {
      "OwnerNames" : [ "yang_test" ]
    },
    "DbaNickName" : "dbaname",
    "OwnerIdList" : {
      "OwnerIds" : [ "10****" ]
    }
  },
  "Success" : true
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.