ListOrders - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération via OpenAPI Explorer, qui génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListOrders	Nom de l'opération à effectuer. Définissez la valeur sur ListOrders.
Tid	Long	No	3000	ID du locataire. Appelez l'opération GetUserActiveTenant ou ListUserTenants pour obtenir cet ID.
PluginType	String	No	DC_COMMON	Type des tickets à lister. Pour plus d'informations, consultez le paramètre PluginType.
OrderResultType	String	No	AS_ADMIN	Portée de la recherche de tickets. Valeurs valides : AS_ADMIN : tous les tickets. AS_COMMITTER : tickets soumis par l'utilisateur actuel. AS_HANDLER : tickets à traiter par l'utilisateur actuel. AS_OWNER : tickets traités par l'utilisateur actuel. AS_Related : tickets liés à l'utilisateur actuel.
SearchDateType	String	No	CREATE_TIME	Critère temporel de recherche. Valeurs valides : CREATE_TIME : date de création du ticket. MODIFY_TIME : date de dernière modification du ticket.
StartTime	String	No	2022-04-08 11:00:00	Début de la plage de temps à interroger.
EndTime	String	No	2022-04-09 11:00:00	Fin de la plage de temps à interroger.
SearchContent	String	No	test	Mot-clé de recherche des tickets.
OrderStatus	String	No	ALL	Statut des tickets à rechercher. Valeurs valides : ALL : tous les statuts. FINISHED : tickets terminés. RUNNING : tickets en cours de traitement.
PageSize	Integer	No	10	Nombre d'entrées par page.
PageNumber	Integer	No	1	Numéro de la page.
RegionId	String	No	cn-hangzhou	Région où DMS est activé. Pour plus d'informations, consultez le paramètre RegionID.

Paramètres de réponse

Parameter	Type	Example	Description
Orders	Array of order		Détails des tickets.
Order
Comment	String	test	Remarques sur le ticket.
LastModifyTime	String	2022-04-08 11:27:45	Date de dernière modification du ticket.
StatusCode	String	success	Code de statut du ticket. Valeurs valides : fail : Échec de l'exécution du ticket. toaudit : Ticket en attente d'approbation. cancel : Ticket annulé. processing : Ticket en cours d'exécution. approved : Ticket approuvé. reject : Ticket rejeté. success : Ticket exécuté avec succès. closed : Ticket fermé.
CreateTime	String	2022-04-08 11:15:46	Date de création du ticket.
Committer	String	test	Utilisateur ayant soumis le ticket.
CommitterId	Long	51****	ID de l'utilisateur ayant soumis le ticket.
StatusDesc	String	The change is successful.	Description du statut du ticket.
PluginType	String	DC_COMMON	Type du ticket.
OrderId	Long	51****	ID du ticket.
TotalCount	Long	1	Nombre total d'entrées renvoyées.
RequestId	String	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D	ID de la requête.
ErrorCode	String	UnknownError	Code d'erreur.
ErrorMessage	String	UnknownError	Message d'erreur.
Success	Boolean	true	Indique si la requête a abouti. Valeurs valides : true : La requête a abouti. false : La requête a échoué.

Exemples

Exemple de requête

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>

Exemples de réponses réussies

Format 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>

Format 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
}

Codes d'erreur

Pour la liste des codes d'erreur, visitez le Centre d'erreurs API.