ListInstances - - Centro de documentación de Alibaba Cloud

Consulta la información de las instancias de base de datos.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListInstances	La operación que desea ejecutar. Establezca el valor en ListInstances.
Tid	Long	No	3***	El ID del inquilino. Llame a la operación GetUserActiveTenant para obtener el ID del inquilino.
SearchKey	String	No	test	La palabra clave utilizada para buscar instancias de base de datos.
DbType	String	No	MySQL	El tipo de base de datos. Para obtener más información sobre los valores válidos de este parámetro, consulte Parámetro DbType.
EnvType	String	No	product	El tipo de entorno al que pertenece 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 pruebas de integración del sistema (SIT) uat: entorno de pruebas de aceptación del usuario (UAT) pet: entorno de pruebas de estrés stag: entorno de preparación
InstanceSource	String	No	RDS	El origen de la instancia de base de datos. Valores válidos: PUBLIC_OWN: una instancia de base de datos autogestionada desplegada en Internet RDS: una instancia de ApsaraDB RDS ECS_OWN: una base de datos autogestionada desplegada en una instancia de Elastic Compute Service (ECS) VPC_IDC: una instancia de base de datos autogestionada desplegada en un centro de datos conectado mediante una nube privada virtual (VPC)
NetType	String	No	VPC	El tipo de red de la instancia de base de datos. Valores válidos: CLASSIC: red clásica VPC: VPC
InstanceState	String	No	NORMAL	El estado de la instancia de base de datos. Valores válidos: NORMAL: normal DISABLE: deshabilitada
PageNumber	Integer	No	1	El número de página por devolver.
PageSize	Integer	No	50	El número de entradas por devolver en cada página. Este valor no puede exceder 100.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
TotalCount	Long	1	El número total de instancias de base de datos devueltas.
RequestId	String	B4B07137-F6AE-4756-8474-7F92BB6C4E04	El ID de la solicitud.
ErrorCode	String	UnknownError	El código de error devuelto si la solicitud falló.
ErrorMessage	String	UnknownError	El mensaje de error devuelto si la solicitud falló.
InstanceList	Array of Instance		La información de las instancias de base de datos devueltas.
Instance
VpcId	String	vpc-o6wrloqsdqc9io3mg****	El ID de la VPC a la que pertenece la instancia de base de datos.
DatabaseUser	String	dbUser	La cuenta utilizada para iniciar sesión en la base de datos.
DbaId	String	31****	El ID del administrador de bases de datos (DBA) de la instancia de base de datos.
UseDsql	Integer	1	Indica si la función de consulta entre bases de datos está habilitada para la instancia de base de datos. Valores válidos: 0: deshabilitada 1: habilitada
Port	Integer	3306	El puerto utilizado para conectarse a la instancia de base de datos.
EcsInstanceId	String	150****	El ID de la instancia de ECS donde se despliega la instancia de base de datos.
EnvType	String	product	El tipo de entorno al que pertenece 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 SIT uat: entorno UAT pet: entorno de pruebas de estrés stag: entorno de preparación
Sid	String	test	El ID del sistema (SID) de la instancia de base de datos.
OwnerIdList	Array of String	123453	Los ID de los propietarios de la instancia de base de datos.
SafeRuleId	String	1	El ID del conjunto de reglas de seguridad de la instancia de base de datos.
OwnerNameList	Array of String	yuyang_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	60	El tiempo de espera para consultar datos en la instancia de base de datos.
InstanceSource	String	RDS	El origen de la instancia de base de datos.
Host	String	****.mysql.rds.aliyuncs.com	La dirección de host utilizada para conectarse a la instancia de base de datos.
State	String	NORMAL	El estado de la instancia de base de datos.
DataLinkName	String	dblink_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	150***	El ID de la instancia de base de datos.
InstanceType	String	mysql	El tipo de instancia de base de datos.
DatabasePassword	String	******	La contraseña utilizada para iniciar sesión en la base de datos.
InstanceAlias	String	test	El alias de la instancia de base de datos.
DdlOnline	Integer	1	Indica si la función de cambio de esquema sin bloqueo está habilitada para la instancia de base de datos.
EcsRegion	String	cn-hangzhou	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	test	El nombre del conjunto de reglas de seguridad correspondiente al modo de control.
GroupMode	String	COMMON	El tipo de modo de control. Valores válidos: COMMON: Colaboración de seguridad NONE_CONTROL: Gestión flexible STABLE: Cambio estable
SellSitd	Boolean	true	Indica si la función de protección de datos confidenciales está habilitada para la instancia de base de datos. Valores válidos: true: habilitada false: deshabilitada
Success	Boolean	true	Indica si la solicitud se completó correctamente. Valores válidos: true: La solicitud se completó correctamente. false: La solicitud falló.

Ejemplos

Solicitudes de ejemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=ListInstances
&Tid=3***
&SearchKey=test
&DbType=MySQL
&EnvType=product
&InstanceSource=RDS
&NetType=VPC
&InstanceState=NORMAL
&PageNumber=1
&PageSize=50
&Common request parameters

Respuestas exitosas de ejemplo

Formato XML

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

<ListInstancesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>B4B07137-F6AE-4756-8474-7F92BB6C4E04</RequestId>
    <InstanceList>
        <VpcId>vpc-o6wrloqsdqc9io3mg****</VpcId>
        <DatabaseUser>dbUser</DatabaseUser>
        <DbaId>31****</DbaId>
        <UseDsql>1</UseDsql>
        <Port>3306</Port>
        <EcsInstanceId>150****</EcsInstanceId>
        <EnvType>product</EnvType>
        <Sid>test</Sid>
        <OwnerIdList>123453</OwnerIdList>
        <SafeRuleId>1</SafeRuleId>
        <OwnerNameList>yuyang_test</OwnerNameList>
        <DbaNickName>dbaName</DbaNickName>
        <QueryTimeout>60</QueryTimeout>
        <InstanceSource>RDS</InstanceSource>
        <Host>****.mysql.rds.aliyuncs.com</Host>
        <State>NORMAL</State>
        <DataLinkName>dblink_test</DataLinkName>
        <ExportTimeout>86400</ExportTimeout>
        <InstanceId>150***</InstanceId>
        <InstanceType>mysql</InstanceType>
        <DatabasePassword>******</DatabasePassword>
        <InstanceAlias>test</InstanceAlias>
        <DdlOnline>1</DdlOnline>
        <EcsRegion>cn-hangzhou</EcsRegion>
        <StandardGroup>
            <GroupName>test</GroupName>
            <GroupMode>COMMON</GroupMode>
        </StandardGroup>
        <SellSitd>true</SellSitd>
    </InstanceList>
    <Success>true</Success>
</ListInstancesResponse>

Formato JSON

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

{
  "TotalCount" : 1,
  "RequestId" : "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
  "InstanceList" : [ {
    "VpcId" : "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser" : "dbUser",
    "DbaId" : "31****",
    "UseDsql" : 1,
    "Port" : 3306,
    "EcsInstanceId" : "150****",
    "EnvType" : "product",
    "Sid" : "test",
    "OwnerIdList" : [ "123453" ],
    "SafeRuleId" : "1",
    "OwnerNameList" : [ "yuyang_test" ],
    "DbaNickName" : "dbaName",
    "QueryTimeout" : 60,
    "InstanceSource" : "RDS",
    "Host" : "****.mysql.rds.aliyuncs.com",
    "State" : "NORMAL",
    "DataLinkName" : "dblink_test",
    "ExportTimeout" : 86400,
    "InstanceId" : "150***",
    "InstanceType" : "mysql",
    "DatabasePassword" : "******",
    "InstanceAlias" : "test",
    "DdlOnline" : 1,
    "EcsRegion" : "cn-hangzhou",
    "StandardGroup" : {
      "GroupName" : "test",
      "GroupMode" : "COMMON"
    },
    "SellSitd" : true
  } ],
  "Success" : true
}

Códigos de error

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