ListRule - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les règles par page.

Limites de QPS

Vous pouvez appeler cette opération d'API jusqu'à 20 fois par seconde par compte.

Remarque

Les utilisateurs RAM (Resource Access Management) d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de la signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListRule	L'opération que vous souhaitez effectuer. Définissez la valeur sur ListRule.
CurrentPage	Integer	Oui	1	Le numéro de page. Valeur maximale : 1000. Valeur par défaut : 1.
PageSize	Integer	Oui	2	Le nombre d'entrées par page. Valeurs valides : 1 à 100. Valeur par défaut : 10.
IotInstanceId	String	Non	iot_instc_pu*_c-v64	L'ID de l'instance. Vous pouvez afficher l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Important Si l'instance possède un ID, vous devez spécifier ce paramètre. Si vous ne le spécifiez pas, la requête échoue. Si l'onglet Overview ou l'ID de l'instance n'est pas affiché dans la console IoT Platform, vous n'avez pas besoin de spécifier ce paramètre. Pour plus d'informations sur les instances, consultez Présentation.
ResourceGroupId	String	Non	rg-acfmxazb4ph****	L'ID du groupe de ressources. Important IoT Platform prend en charge la gestion des groupes de ressources uniquement par instance. Le paramètre ResourceGroupId est invalide. Vous n'avez pas besoin de spécifier ce paramètre.

En plus des paramètres de requête spécifiques à l'opération mentionnés précédemment, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez <a class="xref" data-link-href-cangjie="~~30561~~" href="/help/fr/iot/developer-reference/common-parameters" id="xref_yht_mkd_otr" rel="noopener noreferrer" target="_blank">Paramètres communs</a>.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de la requête. Pour plus d'informations, consultez Codes d'erreur.
Data	Array of RuleInfo		Les règles renvoyées si la requête a réussi. Pour plus d'informations, consultez la description du paramètre RuleInfo dans cette rubrique. Remarque Les règles renvoyées sont triées par ordre décroissant en fonction de l'heure de création des règles.
RuleInfo
CreateUserId	Long	1231579085000000	L'ID de l'utilisateur qui a créé la règle.
Created	String	Wed Feb 27 20:45:43 CST 2019	L'heure de création de la règle. L'heure est affichée au format UTC-6.
DataType	String	JSON	Le type de données de la règle. Valeurs valides : JSON et BINARY.
Id	Long	151454	L'ID de la règle.
Modified	String	Wed Feb 27 20:45:43 CST 2019	L'heure de la dernière modification de la règle. L'heure est affichée au format UTC-6.
Name	String	test123	Le nom de la règle.
ProductKey	String	a1KiV	La ProductKey du produit auquel s'applique la règle.
RuleDesc	String	rule1Desc	La description de la règle.
Select	String	deviceName() as deviceName	Le contenu de la clause SELECT dans l'instruction SQL de la règle.
ShortTopic	String	+/thing/event/property/post	Le nom du sujet auquel s'applique la règle, sans la ProductKey. La valeur est au format `${deviceName}/topicShortName`. ${deviceName} indique le nom du dispositif et topicShortName indique le nom personnalisé du sujet. Remarque Le nom du sujet peut contenir le caractère générique `+` ou `#`. Pour plus d'informations, consultez Sujets.
Status	String	STOP	L'état de la règle. Valeurs valides : RUNNING : La règle est en cours d'exécution. STOP : La règle est arrêtée.
Topic	String	/a1T27vz****/+/thing/event/property/post	Le nom du sujet auquel s'applique la règle, incluant la ProductKey. La valeur est au format `${productKey}/${deviceName}/topicShortName`. Remarque Le nom du sujet peut contenir le caractère générique `+` ou `#`. Pour plus d'informations, consultez Sujets.
UtcCreated	String	2019-02-27T12:40:43.000Z	L'heure de création de la règle. L'heure est affichée au format UTC.
UtcModified	String	2019-02-27T12:45:43.000Z	L'heure de la dernière modification de la règle. L'heure est affichée au format UTC.
Where	String	Temperature>35	La condition dans la clause WHERE de l'instruction SQL de la règle.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de la requête.
Page	Integer	1	Le numéro de page.
PageSize	Integer	2	Le nombre d'entrées par page.
RequestId	String	1564B626-DE97-452D-9E9B-305888AC6105	L'ID de la requête.
Success	Boolean	true	Indique si la requête a réussi. Valeurs valides : true false
Total	Integer	25	Le nombre total de pages renvoyées.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=ListRule
&PageSize=2
&CurrentPage=1
&<Common request parameters>

Exemples de réponses réussies

Format XML

<ListRuleResponse>
  <Data>
        <RuleInfo>
              <DataType>JSON</DataType>
              <ProductKey>a1T27vz****</ProductKey>
              <CreateUserId>198426864326****</CreateUserId>
              <UtcModified>2020-02-26T06:38:27.000Z</UtcModified>
              <UtcCreated>2020-02-26T02:50:44.000Z</UtcCreated>
              <Where>Temperature&gt;35</Where>
              <Name>testrule2</Name>
              <Status>STOP</Status>
              <Select>deviceName() as DeviceName</Select>
              <Created>Wed Feb 26 10:50:44 CST 2020</Created>
              <Modified>Wed Feb 26 14:38:27 CST 2020</Modified>
              <Topic>/a1T27vz****/+/thing/event/property/post</Topic>
              <Id>497350</Id>
        </RuleInfo>
  </Data>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <RequestId>1A6131EC-7504-4673-B997-DEFC6B363A37</RequestId>
  <Success>true</Success>
  <Total>5</Total>
</ListRuleResponse>

Format JSON

{
	"Data": {
		"RuleInfo": [
			{
				"DataType": "JSON",
				"ProductKey": "a1T27vz****",
				"CreateUserId": "198426864326****",
				"UtcModified": "2020-02-26T06:38:27.000Z",
				"UtcCreated": "2020-02-26T02:50:44.000Z",
				"Where": "Temperature>35",
				"Name": "testrule2",
				"Status": "STOP",
				"Select": "deviceName() as DeviceName",
				"Created": "Wed Feb 26 10:50:44 CST 2020",
				"Modified": "Wed Feb 26 14:38:27 CST 2020",
				"Topic": "/a1T27vz****/+/thing/event/property/post",
				"Id": 497350
			}
		]
	},
	"Page": 1,
	"PageSize": 1,
	"RequestId": "1A6131EC-7504-4673-B997-DEFC6B363A37",
	"Success": true,
	"Total": 5
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez <a class="xref" data-link-href-cangjie="https://error-center.alibabacloud.com/status/product/Iot" href="https://error-center.alibabacloud.com/status/product/Iot" id="xref_kdf_tuc_tvx" rel="noopener noreferrer" target="_blank">Codes d'erreur de service</a>.