更新时间:2022-03-23 GMT+08:00
分享

修改请求属性

功能介绍

修改请求属性

调试

您可以在API Explorer中调试该接口。

URI

PUT /v2/{project_id}/link/instances/{instance_id}/services/{service_id}/commands/{command_id}/requests/{property_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度:0

最大长度:32

instance_id

String

实例ID

最小长度:0

最大长度:36

service_id

String

服务ID

最小长度:0

最大长度:20

command_id

Integer

命令ID

最小值:0

最大值:99999999999999999

property_id

Integer

属性/请求属性/响应属性ID

最小值:0

最大值:99999999999999999

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:100000

表3 请求Body参数

参数

是否必选

参数类型

描述

property_name

String

属性名称,首位必须为字母,支持大小写字母,数字,中划线及下划线,长度2-50

最小长度:2

最大长度:50

description

String

属性描述,长度0-200

最小长度:0

最大长度:200

data_type

String

属性数据类型,枚举值大小写敏感;number格式为数字,范围±1.0 x 10^-28 to ±7.9228 x 10^28;string为字符串;integer为整数;datetime为时间,格式为yyyyMMddTHHmmss;json为自定义json格式

最小长度:0

最大长度:10

required

Integer

是否必填 0-非必填 1-必填

最小值:0

最大值:10

min

String

最小值,当data_type为integer或number时必填

缺省值:0

最小长度:0

最大长度:10

max

String

最大值,当data_type为integer或number时必填

缺省值:65536

最小长度:0

最大长度:10

step

String

步长,当data_type为integer或number时必填

缺省值:1

最小长度:0

最大长度:10

max_length

Integer

字符串最大长度,当data_type为string, datetime, json时必填,自动向下取整

最小值:0

最大值:9999999

缺省值:10

unit

String

属性单位

最小长度:0

最大长度:10

enum_list

String

string的枚举值数组,使用逗号分隔

最小长度:0

最大长度:2000

method

String

访问模式(兼容20.0,R属性可读,W属性可写,E属性可执行)

最小长度:1

最大长度:3

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

property_id

Integer

属性ID

最小值:1

最大值:99999999999999999

property_name

String

属性名称,首位必须为字母,支持大小写字母,数字,中划线及下划线,长度2-50

最小长度:2

最大长度:50

description

String

属性描述,长度0-200

最小长度:0

最大长度:200

data_type

String

属性数据类型,枚举值大小写敏感;number格式为数字,范围±1.0 x 10^-28 to ±7.9228 x 10^28;string为字符串;integer为整数;datetime为时间,格式为yyyyMMddTHHmmss;json为自定义json格式

最小长度:0

最大长度:10

required

Integer

是否必填 0-非必填 1-必填

最小值:0

最大值:10

min

String

最小值,当data_type为integer或number时有效

缺省值:0

最小长度:0

最大长度:10

max

String

最大值,当data_type为integer或number时有效

缺省值:65536

最小长度:0

最大长度:10

step

String

步长,当data_type为integer或number时有效

缺省值:1

最小长度:0

最大长度:10

max_length

Integer

字符串最大长度,当data_type为string, datetime, json时有效

最小值:1

最大值:99999999

缺省值:10

unit

String

属性单位

最小长度:0

最大长度:10

enum_list

String

string的枚举值数组,使用逗号分隔

最小长度:0

最大长度:2000

method

String

访问模式(兼容20.0,R属性可读,W属性可写,E属性可执行)

最小长度:1

最大长度:3

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

请求示例

{
  "property_name" : "power_usage",
  "description" : "power_usage",
  "data_type" : "integer",
  "required" : 0,
  "min" : "0",
  "max" : "1000",
  "step" : "1"
}

响应示例

状态码: 200

OK

{
  "property_id" : 3320,
  "property_name" : "p2",
  "description" : null,
  "data_type" : "datetime",
  "required" : 0,
  "min" : 0,
  "max" : 65536,
  "step" : 1,
  "max_length" : "10",
  "unit" : "yuan",
  "enum_list" : null,
  "method" : "RWE"
}

状态码: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-services-requests.updateCommandSend]. Parameter is [command_id]. Processor is [path].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.",
  "request_id" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01"
}

状态码: 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close