ListInstances - - Centro de documentación de Alibaba Cloud

Consulta una lista de instancias.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos ejecutar esta operación en OpenAPI Explorer. Esta herramienta genera de forma dinámica el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListInstances	La operación que desea ejecutar.
ProjectEnv	String	Sí	PROD	El entorno del espacio de trabajo. Valores válidos: PROD y DEV. El valor PROD indica el entorno de producción. El valor DEV indica el entorno de desarrollo.
NodeId	Long	No	100000000000	El identificador del nodo. Llame a la operación ListNodes para consultar este identificador.
NodeName	String	No	openmr_8****	El nombre del nodo. Llame a la operación ListNodes para consultar este nombre.
Owner	String	No	193379****	El identificador de la cuenta de Alibaba Cloud que utiliza el administrador del espacio de trabajo. Inicie sesión en Alibaba Cloud Management Console y consulte este identificador en la página Security Settings.
ProjectId	Long	Sí	12345	El identificador del espacio de trabajo. Llame a la operación ListProjects para consultar este identificador.
BizName	String	No	test_bizName	El nombre del flujo de trabajo. Llame a la operación ListBusiness para consultar este nombre.
ProgramType	String	No	ODPS_SQL	El tipo de nodo. Llame a la operación ListNodes para consultar este tipo.
PageNumber	Integer	No	1	El número de página. Valores válidos: de 1 a 100.
PageSize	Integer	No	10	El número de entradas por página. Valores válidos: de 1 a 100. Valor predeterminado: 10.
DagId	Long	No	11111	El identificador del grafo acíclico dirigido (DAG). Establezca este parámetro con el valor de DagId que devuelven las operaciones RunCycleDagNodes, RunSmokeTest o RunManualDagNodes. La operación RunManualDagNodes sirve para rellenar datos, RunSmokeTest ejecuta pruebas de humo y RunManualDagNodes ejecuta nodos en un flujo de trabajo activado manualmente.
Bizdate	String	No	2020-02-02 00:00:00	La marca de tiempo de los datos de las instancias que desea consultar. Especifique la marca de tiempo con el formato yyyy-MM-dd HH:mm:ss.
BeginBizdate	String	No	2020-02-02 00:00:00	El inicio del intervalo de tiempo que se va a consultar. Especifique la hora con el formato yyyy-MM-dd HH:mm:ss.
EndBizdate	String	No	2020-02-03 00:00:00	El final del intervalo de tiempo que se va a consultar. Especifique la hora con el formato yyyy-MM-dd HH:mm:ss.
Status	String	No	NOT_RUN	El estado del nodo. Valores válidos: NOT_RUN: el nodo no se ha ejecutado. WAIT_TIME: el nodo espera a que llegue la hora programada. WAIT_RESOURCE: el nodo espera recursos. RUNNING: el nodo se está ejecutando. CHECKING: se comprueba la calidad de los datos del nodo. CHECKING_CONDITION: se comprueban las condiciones de la rama del nodo. FAILURE: la ejecución del nodo terminó con errores. SUCCESS: el nodo se ejecutó correctamente.
OrderBy	String	No	INSTANCE_ID_DESC	La regla de ordenamiento de las instancias que se devolverán. Valores válidos: CREATE_TIME_DESC: las instancias se ordenan de forma descendente según su hora de creación. INSTANCE_ID_DESC (predeterminado): las instancias se ordenan de forma descendente según su identificador.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	El código de estado HTTP.
RequestId	String	E6F0DBDD-5AD****	El identificador de la solicitud.
ErrorMessage	String	The project does not exist.	El mensaje de error.
ErrorCode	String	Invalid.Tenant.ProjectNotExists	El código de error.
Success	Boolean	true	Indica si la solicitud se procesó correctamente. Valores válidos: true false
Data	Object		Las instancias devueltas.
PageNumber	Integer	1	El número de página.
PageSize	Integer	10	El número de entradas por página. Valores válidos: de 1 a 100. Valor predeterminado: 10.
TotalCount	Integer	66	El número total de instancias devueltas.
Instances	Array of Instance		La información de las instancias.
Status	String	NOT_RUN	El estado del nodo. Valores válidos: NOT_RUN: el nodo no se ha ejecutado. WAIT_TIME: el nodo espera a que llegue la hora programada. WAIT_RESOURCE: el nodo espera recursos. RUNNING: el nodo se está ejecutando. CHECKING: se comprueba la calidad de los datos del nodo. CHECKING_CONDITION: se comprueban las condiciones de la rama del nodo. FAILURE: la ejecución del nodo terminó con errores. SUCCESS: el nodo se ejecutó correctamente.
CycTime	Long	1590422400000	La hora en la que se programó la ejecución del nodo.
BeginRunningTime	Long	1590416703313	La hora en la que la instancia comenzó a ejecutarse.
FinishTime	Long	1590416703313	La hora en la que el nodo dejó de ejecutarse.
ErrorMessage	String	error message	El mensaje de error. Este parámetro está obsoleto. Llame a la operación GetInstanceLog para consultar la información de error relacionada con el nodo.
CreateTime	Long	1590416703313	La hora en la que se generó la instancia.
DagId	Long	33845	El identificador del flujo de trabajo.
Priority	Integer	1	La prioridad de la instancia. Valores válidos: 1, 3, 5, 7 y 8. Un valor más alto indica una prioridad mayor. Valor predeterminado: 1.
TaskType	String	NORMAL(0)	El tipo de programación del nodo. Valores válidos: NORMAL(0): el nodo se activa automáticamente. El sistema de programación lo ejecuta de forma periódica. MANUAL(1): el nodo se activa de forma manual. El sistema de programación no lo ejecuta de manera periódica. PAUSE(2): el nodo está congelado. El sistema de programación lo ejecuta de forma periódica, pero establece su estado como con errores cuando inicia la ejecución. SKIP(3): el nodo es de ejecución simulada. El sistema de programación lo ejecuta de forma periódica, pero establece su estado como correcto cuando inicia la ejecución. SKIP_UNCHOOSE(4): el nodo no está seleccionado dentro de un flujo de trabajo temporal. Este tipo de nodo solo existe en flujos de trabajo temporales. El sistema de programación establece su estado como correcto cuando inicia la ejecución. SKIP_CYCLE(5): el nodo tiene programación semanal o mensual y espera a que llegue la hora programada. El sistema de programación lo ejecuta de forma periódica, pero establece su estado como correcto cuando inicia la ejecución. CONDITION_UNCHOOSE(6): el nodo padre de tipo rama no seleccionó este nodo, por lo que se ejecuta como nodo de ejecución simulada. REALTIME_DEPRECATED(7): el nodo tiene instancias generadas en tiempo real que están obsoletas. El sistema de programación establece su estado como correcto.
ParamValues	String	bizdate=$bizdate tbods=$tbods	Los parámetros relacionados con el nodo.
Connection	String	odps_source	La cadena de conexión.
BaselineId	Long	123123	El identificador de la línea base.
DqcType	Integer	1	Indica si la instancia está asociada a una regla de monitoreo en Data Quality. Valores válidos: 0: la instancia está asociada a una regla de monitoreo en Data Quality. 1: la instancia no está asociada a una regla de monitoreo en Data Quality.
DagType	String	DAILY	El tipo de flujo de trabajo. Valores válidos: DAILY: el flujo de trabajo ejecuta nodos activados automáticamente. MANUAL: el flujo de trabajo ejecuta nodos activados manualmente. SMOKE_TEST: el flujo de trabajo ejecuta pruebas de humo. SUPPLY_DATA: el flujo de trabajo rellena datos.
BusinessId	Long	123	El identificador del flujo de trabajo.
TaskRerunTime	Integer	0	El número de veces que se puede volver a ejecutar el nodo. Este valor puede estar vacío o ser un entero mayor o igual a 0. Si el valor está vacío, no se especificó un límite de reejecuciones. Si el valor es 0, el nodo no se puede volver a ejecutar. Si el valor es un entero positivo n, el nodo se puede volver a ejecutar n veces. Por ejemplo, si el valor es 1, el nodo admite una reejecución más; si es 2, admite dos.
ModifyTime	Long	1590416703313	La hora de la última modificación del nodo.
Repeatability	Boolean	true	Indica si el nodo se puede volver a ejecutar.
RepeatInterval	Long	60000	El intervalo con el que se vuelve a ejecutar el nodo después de que su ejecución termine con errores. Unidad: milisegundos.
InstanceId	Long	1234	El identificador de la instancia.
BeginWaitResTime	Long	1590416703313	La hora en la que la instancia comenzó a esperar recursos.
RelatedFlowId	Long	123456	El identificador del flujo de trabajo al que pertenece el nodo.
Bizdate	Long	1590336000000	La marca de tiempo de los datos de la instancia. En la mayoría de los casos, corresponde al día anterior a la ejecución de la instancia.
NodeName	String	kzh	El nombre del nodo.
BeginWaitTimeTime	Long	1590416703313	La hora en la que la instancia comenzó a esperar su programación.
DqcDescription	String	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]	La tabla y la expresión de filtro de partición de Data Quality asociadas al nodo.
NodeId	Long	33115	El identificador del nodo.
CreateUser	String	Test	El nombre de la cuenta que ejecutó la instancia. Por ejemplo, si se usó la cuenta Test para rellenar datos, este parámetro devuelve Test.

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=ListInstances
&ProjectEnv=PROD
&NodeId=100000000000
&NodeName=openmr_8****
&Owner=193379****
&ProjectId=12345
&BizName=test_bizName
&ProgramType=ODPS_SQL
&PageNumber=1
&PageSize=10
&DagId=11111
&Bizdate=2020-02-02 00:00:00
&BeginBizdate=2020-02-02 00:00:00
&EndBizdate=2020-02-03 00:00:00
&Status=NOT_RUN
&<Common request parameters>

Respuestas de ejemplo correctas

XML formato

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

<ListInstancesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>E6F0DBDD-5AD****</RequestId>
    <ErrorMessage>The project does not exist.</ErrorMessage>
    <ErrorCode>Invalid.Tenant.ProjectNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>66</TotalCount>
        <Instances>
            <Status>NOT_RUN</Status>
            <CycTime>1590422400000</CycTime>
            <BeginRunningTime>1590416703313</BeginRunningTime>
            <FinishTime>1590416703313</FinishTime>
            <ErrorMessage>error message</ErrorMessage>
            <CreateTime>1590416703313</CreateTime>
            <DagId>33845</DagId>
            <Priority>1</Priority>
            <TaskType>NORMAL(0)</TaskType>
            <ParamValues>bizdate=$bizdate tbods=$tbods</ParamValues>
            <Connection>odps_source</Connection>
            <BaselineId>123123</BaselineId>
            <DqcType>1</DqcType>
            <DagType>DAILY</DagType>
            <BusinessId>123</BusinessId>
            <TaskRerunTime>0</TaskRerunTime>
            <ModifyTime>1590416703313</ModifyTime>
            <Repeatability>true</Repeatability>
            <RepeatInterval>60000</RepeatInterval>
            <InstanceId>1234</InstanceId>
            <BeginWaitResTime>1590416703313</BeginWaitResTime>
            <RelatedFlowId>123456</RelatedFlowId>
            <Bizdate>1590336000000</Bizdate>
            <NodeName>kzh</NodeName>
            <BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>
            <DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
            <NodeId>33115</NodeId>
            <CreateUser>Test</CreateUser>
        </Instances>
    </Data>
</ListInstancesResponse>

JSON formato

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "E6F0DBDD-5AD****",
  "ErrorMessage" : "The project does not exist.",
  "ErrorCode" : "Invalid.Tenant.ProjectNotExists",
  "Success" : true,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 66,
    "Instances" : {
      "Status" : "NOT_RUN",
      "CycTime" : 1590422400000,
      "BeginRunningTime" : 1590416703313,
      "FinishTime" : 1590416703313,
      "ErrorMessage" : "error message",
      "CreateTime" : 1590416703313,
      "DagId" : 33845,
      "Priority" : 1,
      "TaskType" : "NORMAL(0)",
      "ParamValues" : "bizdate=$bizdate tbods=$tbods",
      "Connection" : "odps_source",
      "BaselineId" : 123123,
      "DqcType" : 1,
      "DagType" : "DAILY",
      "BusinessId" : 123,
      "TaskRerunTime" : 0,
      "ModifyTime" : 1590416703313,
      "Repeatability" : true,
      "RepeatInterval" : 60000,
      "InstanceId" : 1234,
      "BeginWaitResTime" : 1590416703313,
      "RelatedFlowId" : 123456,
      "Bizdate" : 1590336000000,
      "NodeName" : "kzh",
      "BeginWaitTimeTime" : 1590416703313,
      "DqcDescription" : "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
      "NodeId" : 33115,
      "CreateUser" : "Test"
    }
  }
}

Códigos de error

Para consultar la lista de códigos de error, consulte Códigos de error del servicio.