更新时间:2024-11-25 GMT+08:00
分享

创建编解码函数

功能介绍

提供创建编解码函数的功能。

调用方法

请参见如何调用API

URI

POST /v5/iot/{project_id}/product-functions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

app_id

String

参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,可以携带该参数查询指定资源空间下的产品列表,不携带该参数则会查询该用户下所有产品列表。

取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

product_id

String

参数说明:设备关联的产品ID,用于唯一标识一个产品模型,创建产品后获得。方法请参见 创建产品

取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

urn

String

参数说明:产品关联函数的URN(Uniform Resource Name)。

取值范围:长度不超过256,只允许字母、数字、下划线(_)、连接符(-)、分隔符(:)的组合。

description

String

参数说明:编解码函数描述信息。

取值范围:长度不超过128,只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

app_id

String

参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,可以携带该参数查询指定资源空间下的产品列表,不携带该参数则会查询该用户下所有产品列表。

取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

product_id

String

参数说明:设备关联的产品ID,用于唯一标识一个产品模型,创建产品后获得。方法请参见 创建产品

取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

function_id

String

参数说明:函数ID,产品配置函数后生成的唯一标识。

取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

urn

String

参数说明:产品关联函数的URN(Uniform Resource Name)。

取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)、分隔符(:)的组合。

description

String

参数说明:编解码函数描述信息。

取值范围:长度不超过128,只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。

create_time

String

参数说明:产品函数创建时间。格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

请求示例

创建编解码函数

POST https://{endpoint}/v5/iot/{project_id}/product-functions

{
  "app_id" : "0ab87ceecbfc49acbcc8d5acdef3c68c",
  "product_id" : "5ba24f5ebbe8f56f5a14f605",
  "urn" : "urn:fss:cn-north-4:46b6f338fc3445b8846c71dfb1fbd9e8:function:java:codecFunc",
  "description" : "xxx"
}

响应示例

状态码: 201

Created

{
  "app_id" : "0ab87ceecbfc49acbcc8d5acdef3c68c",
  "product_id" : "5ba24f5ebbe8f56f5a14f605",
  "function_id" : "9739d740-4da1-46e1-8075-77145265cd92",
  "urn" : "urn:fss:cn-north-4:46b6f338fc3445b8846c71dfb1fbd9e8:function:java:codecFunc",
  "description" : "xxx",
  "create_time" : "20190303T081011Z"
}

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
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 AddFunctionsSolution {

    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();
        AddFunctionsRequest request = new AddFunctionsRequest();
        FunctionRequestDTO body = new FunctionRequestDTO();
        body.withDescription("xxx");
        body.withUrn("urn:fss:cn-north-4:46b6f338fc3445b8846c71dfb1fbd9e8:function:java:codecFunc");
        body.withProductId("5ba24f5ebbe8f56f5a14f605");
        body.withAppId("0ab87ceecbfc49acbcc8d5acdef3c68c");
        request.withBody(body);
        try {
            AddFunctionsResponse response = client.addFunctions(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
# 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 = AddFunctionsRequest()
        request.body = FunctionRequestDTO(
            description="xxx",
            urn="urn:fss:cn-north-4:46b6f338fc3445b8846c71dfb1fbd9e8:function:java:codecFunc",
            product_id="5ba24f5ebbe8f56f5a14f605",
            app_id="0ab87ceecbfc49acbcc8d5acdef3c68c"
        )
        response = client.add_functions(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
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.AddFunctionsRequest{}
	descriptionFunctionRequestDto:= "xxx"
	appIdFunctionRequestDto:= "0ab87ceecbfc49acbcc8d5acdef3c68c"
	request.Body = &model.FunctionRequestDto{
		Description: &descriptionFunctionRequestDto,
		Urn: "urn:fss:cn-north-4:46b6f338fc3445b8846c71dfb1fbd9e8:function:java:codecFunc",
		ProductId: "5ba24f5ebbe8f56f5a14f605",
		AppId: &appIdFunctionRequestDto,
	}
	response, err := client.AddFunctions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

201

Created

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档