ListOrders - - Centro de documentación de Alibaba Cloud

Consulta tickets en Data Management (DMS).

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente 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í	ListOrders	La operación que desea ejecutar. Establezca el valor en ListOrders.
Tid	Long	No	3000	El ID del inquilino. Llame a la operación GetUserActiveTenant o ListUserTenants para obtenerlo.
PluginType	String	No	DC_COMMON	El tipo de tickets que desea consultar. Para más información, consulte Parámetro PluginType.
OrderResultType	String	No	AS_ADMIN	El alcance de los tickets que desea consultar. Valores válidos: AS_ADMIN: todos los tickets. AS_COMMITTER: tickets enviados por el usuario actual. AS_HANDLER: tickets pendientes de procesamiento por el usuario actual. AS_OWNER: tickets procesados por el usuario actual. AS_Related: tickets relacionados con el usuario actual.
SearchDateType	String	No	CREATE_TIME	La condición temporal para consultar tickets. Valores válidos: CREATE_TIME: hora de creación del ticket. MODIFY_TIME: hora de la última modificación del ticket.
StartTime	String	No	2022-04-08 11:00:00	Inicio del intervalo de tiempo a consultar.
EndTime	String	No	2022-04-09 11:00:00	Fin del intervalo de tiempo a consultar.
SearchContent	String	No	test	Palabra clave para consultar tickets.
OrderStatus	String	No	ALL	Estado de los tickets que desea consultar. Valores válidos: ALL: consulta tickets de todos los estados. FINISHED: consulta tickets completados. RUNNING: consulta tickets en proceso.
PageSize	Integer	No	10	Número de entradas a devolver por página.
PageNumber	Integer	No	1	Número de página a devolver.
RegionId	String	No	cn-hangzhou	Región donde está activado DMS. Para más información, consulte Parámetro RegionID.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Orders	Array of order		Detalles de los tickets.
Order
Comment	String	test	Observaciones del ticket.
LastModifyTime	String	2022-04-08 11:27:45	Hora de la última modificación del ticket.
StatusCode	String	success	Código de estado del ticket. Valores válidos: fail: La ejecución del ticket falló. toaudit: El ticket está pendiente de aprobación. cancel: El ticket se canceló. processing: El ticket se está ejecutando. approved: El ticket se aprobó. reject: El ticket se rechazó. success: El ticket se ejecutó correctamente. closed: El ticket está cerrado.
CreateTime	String	2022-04-08 11:15:46	Hora de creación del ticket.
Committer	String	test	Usuario que envió el ticket.
CommitterId	Long	51****	ID del usuario que envió el ticket.
StatusDesc	String	The change is successful.	Descripción del estado del ticket.
PluginType	String	DC_COMMON	Tipo de ticket.
OrderId	Long	51****	ID del ticket.
TotalCount	Long	1	Número total de entradas devueltas.
RequestId	String	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D	ID de la solicitud.
ErrorCode	String	UnknownError	Código de error.
ErrorMessage	String	UnknownError	Mensaje de error.
Success	Boolean	true	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.

Ejemplos

Solicitudes de ejemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=ListOrders
&Tid=3***
&PluginType=DC_COMMON
&OrderResultType=AS_ADMIN
&SearchDateType=CREATE_TIME
&StartTime=2019-10-10 00:00:00
&EndTime=2019-10-11 00:00:00
&SearchContent=test
&OrderStatus=ALL
&PageSize=10
&PageNumber=1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

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

<ListOrdersResponse>
    <Orders>
        <Comment>test</Comment>
        <LastModifyTime>2022-04-08 11:27:45</LastModifyTime>
        <StatusCode>success</StatusCode>
        <CreateTime>2022-04-08 11:15:46</CreateTime>
        <Committer>test</Committer>
        <StatusDesc>The change is successful.</StatusDesc>
        <PluginType>DC_COMMON</PluginType>
    </Orders>
    <TotalCount>1</TotalCount>
    <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
</ListOrdersResponse>

Formato JSON

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

{
  "Orders": [
    {
      "StatusDesc": "The change is successful.",
      "Comment": "test",
      "CreateTime": "2022-04-08 11:15:46",
      "Committer": "test_name",
      "OrderId": 5192547,
      "LastModifyTime": "2022-04-08 11:27:45",
      "PluginType": "DC_COMMON",
      "CommitterId": "51****",
      "StatusCode": "success"
    },
  ],
  "TotalCount": 1,
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "Success": true
}

Códigos de error

Para consultar una lista de códigos de error, visite el Centro de errores de API.