创建编解码函数
功能介绍
提供创建编解码函数的功能。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v5/iot/{project_id}/product-functions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app_id |
否 |
String |
参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的编解码函数列表，不携带该参数则会查询该用户下所有编解码函数列表。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
product_id |
是 |
String |
参数说明：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 创建产品。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
urn |
是 |
String |
参数说明：产品关联函数的URN（Uniform Resource Name）。 取值范围：长度不超过256，只允许字母、数字、下划线（_）、连接符（-）、分隔符（:）的组合。 |
|
description |
否 |
String |
参数说明：编解码函数描述信息。 取值范围：长度不超过128，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
