更新时间:2024-04-29 GMT+08:00
分享

查询数据流转流控策略列表

功能介绍

应用服务器可调用此接口查询在物联网平台设置的数据流转流控策略列表。

调用方法

请参见如何调用API

URI

GET /v5/iot/{project_id}/routing-rule/flowcontrol-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

scope

String

参数说明:流控策略作用域。不携带该参数时,查询所有作用域流控策略;取值USER时,查询租户级流控策略;取值为CHANNEL时,查询转发通道级流控策略;取值为RULE时,查询转发规则级流控策略;取值为ACTION时,查询转发动作级流控策略。

scope_value

String

参数说明:流控策略作用域附加值。 不携带scope参数或scope参数取值为USER时,可不携带该字段,查询租户级流控策略。 scope参数取值为CHANNEL时,不携带该字段表示查询所有转发通道级流控策略,携带该字段表示查询该字段取值对应转发通道的流控策略。取值范围:HTTP_FORWARDING、DIS_FORWARDING、OBS_FORWARDING、AMQP_FORWARDING、DMS_KAFKA_FORWARDING。 scope参数为RULE时,不携带该字段表示查询所有转发规则级流控策略,携带该字段表示查询该字段取值对应转发规则的流控策略。 scope参数为ACTION时,不携带该字段表示查询所有转发动作级流控策略,携带该字段表示查询该字段取值对应转发动作的流控策略。

policy_name

String

参数说明:数据流转流控策略名称。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

最小长度:1

最大长度:256

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

flowcontrol_policies

Array of FlowControlPolicyInfo objects

数据流转流控策略列表。

数组长度:0 - 50

count

Integer

满足查询条件的记录总数。

marker

String

本次分页查询结果中最后一条记录的ID,可在下一次分页查询时使用。

表5 FlowControlPolicyInfo

参数

参数类型

描述

policy_id

String

参数说明:数据流转流控策略id,用于唯一标识一个数据流转流控策略,在创建数据流转流控策略时由物联网平台分配获得。

policy_name

String

参数说明:数据流转流控策略名称。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

最小长度:1

最大长度:256

description

String

参数说明:用户自定义的数据流转流控策略描述。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

最小长度:1

最大长度:256

scope

String

参数说明:流控策略作用域. 取值范围

  • USER:租户级流控策略。

  • CHANNEL:转发通道级流控策略。

  • RULE:转发规则级流控策略。

  • ACTION:转发动作级流控策略。

scope_value

String

参数说明:流控策略作用域附加值。 scope取值为USER时,可不携带该字段,表示租户级流控。 scope取值为CHANNEL时,取值范围:HTTP_FORWARDING、DIS_FORWARDING、OBS_FORWARDING、AMQP_FORWARDING、DMS_KAFKA_FORWARDING。 scope取值为RULE时,该字段为对应的ruleId。 scope取值为ACTION时,该字段为对应的actionId。

limit

Integer

参数说明:数据转发流控大小。单位为tps,取值范围为1~1000的整数,默认为1000.

最小值:1

最大值:1000

缺省值:1000

请求示例

查询数据流转流控策略列表。

GET https://{endpoint}/v5/iot/{project_id}/routing-rule/flowcontrol-policy

响应示例

状态码: 200

Ok

{
  "flowcontrol_policies" : [ {
    "policy_id" : "adadd5cb-6383-4b5b-a65c-f8c92fdf3c34",
    "policy_name" : "policyName",
    "description" : "description",
    "scope" : "CHANNEL",
    "scope_value" : "HTTP_FORWARDING",
    "limit" : 10
  } ],
  "count" : 10,
  "marker" : "5c90fa7d3c4e4405e8525079"
}

SDK代码示例

SDK代码示例如下。

Java

 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
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.iotda.v5.region.IoTDARegion;
import com.huaweicloud.sdk.iotda.v5.*;
import com.huaweicloud.sdk.iotda.v5.model.*;


public class ListRoutingFlowControlPolicySolution {

    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");

        ICredential auth = new BasicCredentials()
                .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios
                .withAk(ak)
                .withSk(sk);

        IoTDAClient client = IoTDAClient.newBuilder()
                .withCredential(auth)
                .withRegion(IoTDARegion.valueOf("<YOUR REGION>"))
                .build();
        ListRoutingFlowControlPolicyRequest request = new ListRoutingFlowControlPolicyRequest();
        request.withScope("<scope>");
        request.withScopeValue("<scope_value>");
        request.withPolicyName("<policy_name>");
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withOffset(<offset>);
        try {
            ListRoutingFlowControlPolicyResponse response = client.listRoutingFlowControlPolicy(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());
        }
    }
}

Python

 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcore.auth.credentials import DerivedCredentials
from huaweicloudsdkiotda.v5.region.iotda_region import IoTDARegion
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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \
            .with_derived_predicate(DerivedCredentials.get_default_derived_predicate()) \

    client = IoTDAClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(IoTDARegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListRoutingFlowControlPolicyRequest()
        request.scope = "<scope>"
        request.scope_value = "<scope_value>"
        request.policy_name = "<policy_name>"
        request.limit = <limit>
        request.marker = "<marker>"
        request.offset = <offset>
        response = client.list_routing_flow_control_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
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/services/iotda/v5/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios
        Build()

    client := iotda.NewIoTDAClient(
        iotda.IoTDAClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListRoutingFlowControlPolicyRequest{}
	scopeRequest:= "<scope>"
	request.Scope = &scopeRequest
	scopeValueRequest:= "<scope_value>"
	request.ScopeValue = &scopeValueRequest
	policyNameRequest:= "<policy_name>"
	request.PolicyName = &policyNameRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	response, err := client.ListRoutingFlowControlPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Ok

400

Bad Request

403

Forbidden

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品