查询规则条件列表
功能介绍
应用服务器可调用此接口查询物联网平台中设置的规则条件列表。
调用方法
请参见如何调用API。
URI
GET /v5/iot/{project_id}/routing-rule/rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数说明:项目ID。获取方法请参见 获取项目ID 。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resource |
否 |
String |
参数说明:订阅的资源名称。 取值范围:
最小长度:1 最大长度:50 |
event |
否 |
String |
参数说明:订阅的资源事件。 取值范围:与资源有关,不同的资源,事件不同。 event需要与resource关联使用,具体的“resource:event”映射关系如下:
最小长度:1 最大长度:50 |
app_type |
否 |
String |
参数说明:租户规则的生效范围。 取值范围:
|
app_id |
否 |
String |
参数说明:资源空间ID。此参数为非必选参数,携带app_id查询指定资源空间下的规则动作列表,不携带app_id则查询默认资源空间下的规则动作列表。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。 |
rule_name |
否 |
String |
参数说明:用户自定义的规则名称 最小长度:1 最大长度:256 |
active |
否 |
Boolean |
参数说明:规则条件的状态是否为激活。 |
limit |
否 |
Integer |
参数说明:分页查询时每页显示的记录数。默认每页10条记录,最大设定每页50条记录。 取值范围:1-50的整数,默认值为10。 最小值:1 最大值:50 缺省值:10 |
marker |
否 |
String |
参数说明:上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marker的数据记录。若不填写,则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据,则每次查询时必须填写上一次查询响应中的marker值。 取值范围:长度为24的十六进制字符串,默认值为ffffffffffffffffffffffff。 缺省值:ffffffffffffffffffffffff |
offset |
否 |
Integer |
参数说明:表示从marker后偏移offset条记录开始查询。默认为0,取值范围为0-500的整数。当offset为0时,表示从marker后第一条记录开始输出。 - 限制offset最大值是出于API性能考虑,您可以搭配marker使用该参数实现翻页,例如每页50条记录,1-11页内都可以直接使用offset跳转到指定页,但到11页后,由于offset限制为500,您需要使用第11页返回的marker作为下次查询的marker,以实现翻页到12-22页。 取值范围:0-500的整数,默认为0。 最小值:0 最大值:500 缺省值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
rules |
Array of RoutingRule objects |
规则条件信息列表。 |
count |
Integer |
满足查询条件的记录总数。 |
marker |
String |
本次分页查询结果中最后一条记录的ID,可在下一次分页查询时使用。 |
参数 |
参数类型 |
描述 |
---|---|---|
rule_id |
String |
规则触发条件ID,用于唯一标识一个规则触发条件,在创建规则条件时由物联网平台分配获得。 |
rule_name |
String |
用户自定义的规则名称。 最小长度:1 最大长度:256 |
description |
String |
用户自定义的规则描述。 最小长度:1 最大长度:256 |
subject |
RoutingRuleSubject object |
资源事件信息,即资源变化事件。 |
app_type |
String |
租户规则的生效范围,取值如下:
|
app_id |
String |
资源空间ID |
select |
String |
用户自定义sql select语句,最大长度2500,该参数仅供标准版和企业版用户使用。 最小长度:0 最大长度:2500 |
where |
String |
用户自定义sql where语句,最大长度2500,该参数仅供标准版和企业版用户使用。 最小长度:0 最大长度:2500 |
active |
Boolean |
规则条件的状态是否为激活。 |
参数 |
参数类型 |
描述 |
---|---|---|
resource |
String |
参数说明:资源名称。 取值范围:
最小长度:1 最大长度:50 |
event |
String |
参数说明:资源事件。 取值范围:与资源有关,不同的资源,事件不同。event需要与resource关联使用,具体的“resource:event”映射关系如下:
最小长度:1 最大长度:50 |
请求示例
列表查询数据流转规则。
GET https://{endpoint}/v5/iot/{project_id}/routing-rule/rules
响应示例
状态码: 200
Successful response
{ "rules" : [ { "rule_id" : "5bcaddda-75bf-4623-8c8d-26175c41fcca", "app_type" : "GLOBAL", "select" : "*", "rule_name" : "rulename", "subject" : { "resource" : "device", "event" : "create" }, "description" : "description", "active" : true, "where" : "product_id='d89c-44dd-8265-b1653d951ce0'", "app_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce0" } ], "count" : 10, "marker" : "5c90fa7d3c4e4405e8525079" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.AbstractCredentials; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.core.region.Region; import com.huaweicloud.sdk.iotda.v5.*; import com.huaweicloud.sdk.iotda.v5.model.*; public class ListRoutingRulesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); // ENDPOINT:请在控制台的"总览"界面的"平台接入地址"中查看“应用侧”的https接入地址。 String iotdaEndpoint = "<YOUR ENDPOINT>"; ICredential auth = new BasicCredentials() // 标准版/企业版需要使用衍生算法,基础版请删除配置"withDerivedPredicate"; .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios .withAk(ak) .withSk(sk); IoTDAClient client = IoTDAClient.newBuilder() .withCredential(auth) // 标准版/企业版:需自行创建Region对象,基础版:请使用IoTDARegion的region对象,如"withRegion(IoTDARegion.CN_NORTH_4)" .withRegion(new Region("cn-north-4", iotdaEndpoint)) .build(); ListRoutingRulesRequest request = new ListRoutingRulesRequest(); request.withResource("<resource>"); request.withEvent("<event>"); request.withAppType("<app_type>"); request.withAppId("<app_id>"); request.withRuleName("<rule_name>"); request.withActive(<active>); request.withLimit(<limit>); request.withMarker("<marker>"); request.withOffset(<offset>); try { ListRoutingRulesResponse response = client.listRoutingRules(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcore.auth.credentials import DerivedCredentials from huaweicloudsdkcore.region.region import Region as coreRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkiotda.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] // ENDPOINT:请在控制台的"总览"界面的"平台接入地址"中查看“应用侧”的https接入地址。 iotdaEndpoint = "<YOUR ENDPOINT>"; credentials = BasicCredentials(ak, sk).with_derived_predicate(DerivedCredentials.get_default_derived_predicate()) client = IoTDAClient.new_builder() \ .with_credentials(credentials) \ # 标准版/企业版:需要使用自行创建的Region对象,基础版:请选择IoTDAClient中的Region对象 如: .with_region(IoTDARegion.CN_NORTH_4) .with_region(coreRegion(id="cn-north-4", endpoint=endpoint)) \ .build() try: request = ListRoutingRulesRequest() request.resource = "<resource>" request.event = "<event>" request.app_type = "<app_type>" request.app_id = "<app_id>" request.rule_name = "<rule_name>" request.active = <Active> request.limit = <limit> request.marker = "<marker>" request.offset = <offset> response = client.list_routing_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" iotda "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/region" core_auth "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") // endpoint:请在控制台的"总览"界面的"平台接入地址"中查看"应用侧"的https接入地址 endpoint := "<YOUR ENDPOINT>" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). // 企业版/标准版需要使用衍生算法,基础版请删除该配置"WithDerivedPredicate" WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios Build() client := iotda.NewIoTDAClient( iotda.IoTDAClientBuilder(). // 标准版/企业版需要自行创建region,基础版使用IoTDARegion中的region对象 WithRegion(region.NewRegion("cn-north-4", endpoint)). WithCredential(auth). Build()) request := &model.ListRoutingRulesRequest{} resourceRequest:= "<resource>" request.Resource = &resourceRequest eventRequest:= "<event>" request.Event = &eventRequest appTypeRequest:= "<app_type>" request.AppType = &appTypeRequest appIdRequest:= "<app_id>" request.AppId = &appIdRequest ruleNameRequest:= "<rule_name>" request.RuleName = &ruleNameRequest activeRequest:= <active> request.Active = &activeRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListRoutingRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Successful response |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。