修改数据流转积压策略
功能介绍
应用服务器可调用此接口在物联网平台修改指定数据流转积压策略。
调用方法
请参见如何调用API。
URI
PUT /v5/iot/{project_id}/routing-rule/backlog-policy/{policy_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数说明:项目ID。获取方法请参见 获取项目ID 。 |
policy_id |
是 |
String |
参数说明:数据流转积压策略id,用于唯一标识一个数据流转积压策略,在创建数据流转积压策略时由物联网平台分配获得。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明:用户Token。通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
policy_name |
否 |
String |
参数说明:数据流转积压策略名称。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 |
description |
否 |
String |
参数说明:用户自定义的数据流转积压策略描述。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 |
backlog_size |
否 |
Integer |
参数说明:数据积压大小。单位为B(字节),取值范围为0~1073741823的整数,默认为1073741823(即1GB)。当backlog_size为0时,表示不积压。若同时配置了backlog_size和backlog_time两个维度,则以最先达到阈值的维度为准。 |
backlog_time |
否 |
Integer |
参数说明:数据积压时间。单位为s(秒),取值范围为0~86399的整数,默认为86399(即1天)。当backlog_time为0时,表示不积压。若同时配置了backlog_size和backlog_time两个维度,则以最先达到阈值的维度为准。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
policy_id |
String |
参数说明:数据流转积压策略id,用于唯一标识一个数据流转积压策略,在创建数据流转积压策略时由物联网平台分配获得。 |
policy_name |
String |
参数说明:数据流转积压策略名称。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 |
description |
String |
参数说明:用户自定义的数据流转积压策略描述。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 |
backlog_size |
Integer |
参数说明:数据积压大小。单位为B(字节),取值范围为0~1073741823的整数,默认为1073741823(即1GB)。当backlog_size为0时,表示不积压。若同时配置了backlog_size和backlog_time两个维度,则以最先达到阈值的维度为准。 |
backlog_time |
Integer |
参数说明:数据积压时间。单位为s(秒),取值范围为0~86399的整数,默认为86399(即1天)。当backlog_time为0时,表示不积压。若同时配置了backlog_size和backlog_time两个维度,则以最先达到阈值的维度为准。 |
请求示例
更新数据流转积压策略。
PUT https://{endpoint}/v5/iot/{project_id}/routing-rule/backlog-policy/{policy_id} { "backlog_size" : 100, "backlog_time" : 100 }
响应示例
状态码: 200
Ok
{ "policy_id" : "adadd5cb-6383-4b5b-a65c-f8c92fdf3c34", "policy_name" : "policyName", "description" : "description", "backlog_size" : 1073741823, "backlog_time" : 86399 }
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 |
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 UpdateRoutingBacklogPolicySolution { 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>"; String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) // 标准版/企业版需要使用衍生算法,基础版请删除配置"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(); UpdateRoutingBacklogPolicyRequest request = new UpdateRoutingBacklogPolicyRequest(); request.withPolicyId("{policy_id}"); UpdateBacklogPolicy body = new UpdateBacklogPolicy(); body.withBacklogTime(100); body.withBacklogSize(100); request.withBody(body); try { UpdateRoutingBacklogPolicyResponse response = client.updateRoutingBacklogPolicy(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 |
# 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>"; projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId).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 = UpdateRoutingBacklogPolicyRequest() request.policy_id = "{policy_id}" request.body = UpdateBacklogPolicy( backlog_time=100, backlog_size=100 ) response = client.update_routing_backlog_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) |
更新数据流转积压策略。
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 |
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>" projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). // 企业版/标准版需要使用衍生算法,基础版请删除该配置"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.UpdateRoutingBacklogPolicyRequest{} request.PolicyId = "{policy_id}" backlogTimeUpdateBacklogPolicy:= int32(100) backlogSizeUpdateBacklogPolicy:= int32(100) request.Body = &model.UpdateBacklogPolicy{ BacklogTime: &backlogTimeUpdateBacklogPolicy, BacklogSize: &backlogSizeUpdateBacklogPolicy, } response, err := client.UpdateRoutingBacklogPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Ok |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。