model

package
v0.1.44 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 15, 2023 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause Imports: 6 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionDeviceAlarm 

type ActionDeviceAlarm struct {

	// **参数说明**：告警名称。
	Name string `json:"name"`

	// **参数说明**：告警状态。 **取值范围**： - fault：上报告警。 - recovery：恢复告警。
	AlarmStatus string `json:"alarm_status"`

	// **参数说明**：告警级别。 **取值范围**：warning（警告）、minor（一般）、major（严重）和critical（致命）。
	Severity string `json:"severity"`

	// **参数说明**：告警维度，与告警名称和告警级别组合起来共同标识一条告警，默认不携带该字段为用户维度告警，支持设备维度和资源空间维度告警。 **取值范围**： - device：设备维度。 - app：资源空间维度。
	Dimension *string `json:"dimension,omitempty"`

	// **参数说明**：告警的描述信息。
	Description *string `json:"description,omitempty"`
}

上报设备告警消息结构

func (ActionDeviceAlarm) String 

func (o ActionDeviceAlarm) String() string

type ActionDeviceCommand 

type ActionDeviceCommand struct {

	// **参数说明**：下发命令的设备ID。 - 当创建设备数据规则时，若device_id为空，则命令下发给触发条件的设备。  - 当创建定时规则时，不允许为空。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId *string `json:"device_id,omitempty"`

	Cmd *Cmd `json:"cmd"`
}

下发设备命令消息结构

func (ActionDeviceCommand) String 

func (o ActionDeviceCommand) String() string

type ActionSmnForwarding 

type ActionSmnForwarding struct {

	// **参数说明**：SMN服务对应的region区域。
	RegionName string `json:"region_name"`

	// **参数说明**：SMN服务对应的projectId信息。
	ProjectId string `json:"project_id"`

	// **参数说明**：SMN服务对应的主题名称。
	ThemeName string `json:"theme_name"`

	// **参数说明**：SMN服务对应的topic的主题URN。
	TopicUrn string `json:"topic_urn"`

	// **参数说明**：短信或邮件的内容。
	MessageContent string `json:"message_content"`

	// **参数说明**：短信或邮件的主题。
	MessageTitle string `json:"message_title"`
}

发送给SMN消息结构

func (ActionSmnForwarding) String 

func (o ActionSmnForwarding) String() string

type AddActionReq 

type AddActionReq struct {

	// **参数说明**：规则触发条件ID，用于唯一标识一条规则触发条件，在创建规则时由物联网平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	RuleId string `json:"rule_id"`

	// **参数说明**：规则动作的类型。 **取值范围**： - HTTP_FORWARDING：HTTP服务消息类型。 - DIS_FORWARDING：转发DIS服务消息类型。 - OBS_FORWARDING：转发OBS服务消息类型。 - AMQP_FORWARDING：转发AMQP服务消息类型。 - DMS_KAFKA_FORWARDING：转发kafka消息类型。[ - ROMA_FORWARDING：转发Roma消息类型。（仅企业版支持） - INFLUXDB_FORWARDING：转发InfluxDB消息类型。（仅标准版和企业版支持） - MYSQL_FORWARDING：转发MySQL消息类型。（仅标准版和企业版支持） - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。（仅标准版和企业版支持） - MRS_KAFKA_FORWARDING：转发MRS_KAFKA消息类型。（仅企业版支持） - DMS_ROCKETMQ_FORWARDING：转发RocketMQ消息类型。（仅标准版和企业版支持）](tag:hws)[ - INFLUXDB_FORWARDING：转发InfluxDB消息类型。 - MYSQL_FORWARDING：转发MySQL消息类型。 - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。](tag:hws_hk)
	Channel string `json:"channel"`

	ChannelDetail *ChannelDetail `json:"channel_detail"`
}

创建规则动作请求结构体

func (AddActionReq) String 

func (o AddActionReq) String() string

type AddApplication 

type AddApplication struct {

	// **参数说明**：资源空间名称。 **取值范围**：长度不超过64，允许中文、字母、数字、下划线（_）、连接符（-）等一些特殊字符的组合。
	AppName string `json:"app_name"`
}

创建资源空间结构体。

func (AddApplication) String 

func (o AddApplication) String() string

type AddApplicationRequest 

type AddApplicationRequest struct {

	// **参数说明**：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	Body *AddApplication `json:"body,omitempty"`
}

Request Object

func (AddApplicationRequest) String 

func (o AddApplicationRequest) String() string

type AddApplicationResponse 

type AddApplicationResponse struct {

	// 资源空间ID，唯一标识一个资源空间，由物联网平台在创建资源空间时分配。资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 资源空间创建时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 是否为默认资源空间
	DefaultApp     *bool `json:"default_app,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (AddApplicationResponse) String 

func (o AddApplicationResponse) String() string

type AddCertificateRequest 

type AddCertificateRequest struct {

	// Sp用户Token。通过调用IoBPS服务获取SP用户Token
	SpAuthToken *string `json:"Sp-Auth-Token,omitempty"`

	// Stage用户的Token, 仅提供给IoStage服务使用
	StageAuthToken *string `json:"Stage-Auth-Token,omitempty"`

	// 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	Body *CreateCertificateDto `json:"body,omitempty"`
}

Request Object

func (AddCertificateRequest) String 

func (o AddCertificateRequest) String() string

type AddCertificateResponse 

type AddCertificateResponse struct {

	// CA证书ID，在上传CA证书时由平台分配的唯一标识。
	CertificateId *string `json:"certificate_id,omitempty"`

	// CA证书CN名称。
	CnName *string `json:"cn_name,omitempty"`

	// CA证书所有者。
	Owner *string `json:"owner,omitempty"`

	// CA证书验证状态。true代表证书已通过验证，可进行设备证书认证接入。false代表证书未通过验证。
	Status *bool `json:"status,omitempty"`

	// CA证书验证码。
	VerifyCode *string `json:"verify_code,omitempty"`

	// 创建证书日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateDate *string `json:"create_date,omitempty"`

	// CA证书生效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	EffectiveDate *string `json:"effective_date,omitempty"`

	// CA证书失效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	ExpiryDate     *string `json:"expiry_date,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (AddCertificateResponse) String 

func (o AddCertificateResponse) String() string

type AddDevice 

type AddDevice struct {

	// **参数说明**：设备ID，全局唯一，用于唯一标识一个设备。如果携带该参数，平台将设备ID设置为该参数值；如果不携带该参数，设备ID由物联网平台分配获得，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合，建议不少于4个字符。
	DeviceId *string `json:"device_id,omitempty"`

	// **参数说明**：设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。 设备标识码长度为1到64个字符，包含英文字母、数字、连接号“-”和下划线“_”。 注意：NB设备由于模组烧录信息后无法配置，所以NB设备会校验node_id全局唯一。 **取值范围**：长度不超过64，只允许字母、数字、下划线（_）、连接符（-）的组合，建议不少于4个字符。
	NodeId string `json:"node_id"`

	// **参数说明**：设备名称。 **取值范围**：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合，建议不少于4个字符。
	DeviceName *string `json:"device_name,omitempty"`

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId string `json:"product_id"`

	AuthInfo *AuthInfo `json:"auth_info,omitempty"`

	// **参数说明**：设备的描述信息。 **取值范围**：长度不超过2048，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合
	Description *string `json:"description,omitempty"`

	// **参数说明**：网关ID，用于标识设备所属的父设备，即父设备的设备ID。携带该参数时，表示在该父设备下创建一个子设备，这个子设备不与平台直连，此时必须保证这个父设备在平台已存在，创建成功后子设备的gateway_id等于该参数值；不携带该参数时，表示创建一个和平台直连的设备，创建成功后设备的device_id和gateway_id一致。注意：当前平台最多支持二级子设备。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	GatewayId *string `json:"gateway_id,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的设备归属到哪个资源空间下，否则创建的设备将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：设备扩展信息。用户可以自定义任何想要的扩展信息，如果在创建设备时为子设备指定该字段，将会通过MQTT接口“平台通知网关子设备新增“将该信息通知给网关。字段值大小上限为1K。
	ExtensionInfo *interface{} `json:"extension_info,omitempty"`

	// **参数说明**：设备初始配置。用户使用该字段可以为设备指定初始配置，指定后将会根据service_id和desired设置的属性值与产品中对应属性的默认值比对，如果不同，则将以shadow字段中设置的属性值为准写入到设备影子中。service_id的值和desired内的属性必须是profile中定义的。
	Shadow *[]InitialDesired `json:"shadow,omitempty"`
}

添加设备结构体。

func (AddDevice) String 

func (o AddDevice) String() string

type AddDeviceGroupDto 

type AddDeviceGroupDto struct {

	// **参数说明**：设备组名称，单个资源空间下不可重复。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。
	Name *string `json:"name,omitempty"`

	// **参数说明**：设备组描述。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。
	Description *string `json:"description,omitempty"`

	// **参数说明**：父设备组ID，携带该参数时表示在该设备组下创建一个子设备组,动态群组不支持该参数。 **取值范围**：长度不超过36，十六进制字符串和连接符（-）的组合。
	SuperGroupId *string `json:"super_group_id,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的设备组归属到哪个资源空间下，否则创建的设备组将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：设备组类型，默认为静态设备组；当设备组类型为动态设备组时，需要填写动态设备组组规则
	GroupType *string `json:"group_type,omitempty"`

	// **参数说明**：动态设备组规则语法和高级搜索保持一致，只需要填写where 子句内容，其余子句无需填写，todo补充说明
	DynamicGroupRule *string `json:"dynamic_group_rule,omitempty"`
}

创建设备组请求结构体

func (AddDeviceGroupDto) String 

func (o AddDeviceGroupDto) String() string

type AddDeviceGroupRequest 

type AddDeviceGroupRequest struct {

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

	Body *AddDeviceGroupDto `json:"body,omitempty"`
}

Request Object

func (AddDeviceGroupRequest) String 

func (o AddDeviceGroupRequest) String() string

type AddDeviceGroupResponse 

type AddDeviceGroupResponse struct {

	// 设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。
	GroupId *string `json:"group_id,omitempty"`

	// 设备组名称，单个资源空间下不可重复。
	Name *string `json:"name,omitempty"`

	// 设备组描述。
	Description *string `json:"description,omitempty"`

	// 父设备组ID，该设备组的父设备组ID。
	SuperGroupId *string `json:"super_group_id,omitempty"`

	// 设备组类型，分为动态设备组和静态设备组两种
	GroupType *string `json:"group_type,omitempty"`

	// 动态设备组规则
	DynamicGroupRule *string `json:"dynamic_group_rule,omitempty"`
	HttpStatusCode   int     `json:"-"`
}

Response Object

func (AddDeviceGroupResponse) String 

func (o AddDeviceGroupResponse) String() string

type AddDeviceRequest 

type AddDeviceRequest struct {

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

	Body *AddDevice `json:"body,omitempty"`
}

Request Object

func (AddDeviceRequest) String 

func (o AddDeviceRequest) String() string

type AddDeviceResponse 

type AddDeviceResponse struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。
	NodeId *string `json:"node_id,omitempty"`

	// 网关ID，用于标识设备所属的父设备，即父设备的设备ID。当设备是直连设备时，gateway_id与设备的device_id一致。当设备是非直连设备时，gateway_id为设备所关联的父设备的device_id。
	GatewayId *string `json:"gateway_id,omitempty"`

	// 设备名称。
	DeviceName *string `json:"device_name,omitempty"`

	// 设备节点类型。 - ENDPOINT：非直连设备。 - GATEWAY：直连设备或网关。 - UNKNOWN：未知。
	NodeType *string `json:"node_type,omitempty"`

	// 设备的描述信息。
	Description *string `json:"description,omitempty"`

	// 设备的固件版本。
	FwVersion *string `json:"fw_version,omitempty"`

	// 设备的软件版本。
	SwVersion *string `json:"sw_version,omitempty"`

	// 设备的sdk信息。
	DeviceSdkVersion *string `json:"device_sdk_version,omitempty"`

	AuthInfo *AuthInfo `json:"auth_info,omitempty"`

	// 设备关联的产品ID，用于唯一标识一个产品模型。
	ProductId *string `json:"product_id,omitempty"`

	// 设备关联的产品名称。
	ProductName *string `json:"product_name,omitempty"`

	// 设备的状态。 - ONLINE：设备在线。 - OFFLINE：设备离线。 - ABNORMAL：设备异常。 - INACTIVE：设备未激活。 - FROZEN：设备冻结。
	Status *string `json:"status,omitempty"`

	// 在物联网平台注册设备的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 设备最近一次连接状态(ONLINE:在线，OFFLINE：离线，ABNORMAL：异常)变化时间。格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ，如2015-12-12T12:12:122Z。
	ConnectionStatusUpdateTime *string `json:"connection_status_update_time,omitempty"`

	// 设备激活时间。格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ，如2015-12-12T12:12:122Z。
	ActiveTime *string `json:"active_time,omitempty"`

	// 设备的标签列表。
	Tags *[]TagV5Dto `json:"tags,omitempty"`

	// 设备扩展信息。用户可以自定义任何想要的扩展信息，如果在创建设备时为子设备指定该字段，将会通过MQTT接口“平台通知网关子设备新增“将该信息通知给网关。
	ExtensionInfo  *interface{} `json:"extension_info,omitempty"`
	HttpStatusCode int          `json:"-"`
}

Response Object

func (AddDeviceResponse) String 

func (o AddDeviceResponse) String() string

type AddProduct 

type AddProduct struct {

	// **参数说明**：产品ID，资源空间下唯一。常app_id一起使用，用于唯一标识一个产品。如果携带此参数，平台将产品ID设置为该参数值；如果不携带此参数，产品ID在物联网平台创建产品后由平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId *string `json:"product_id,omitempty"`

	// **参数说明**：产品名称。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	Name string `json:"name"`

	// **参数说明**：设备类型。 **取值范围**：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	DeviceType string `json:"device_type"`

	// **参数说明**：设备使用的协议类型。 **取值范围**：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF，OPC-UA，OPC-DA，Other。
	ProtocolType string `json:"protocol_type"`

	// **参数说明**：设备上报数据的格式。 **取值范围**： - json：JSON格式 - binary：二进制码流格式 默认值json。
	DataFormat string `json:"data_format"`

	// **参数说明**：设备的服务能力列表。 **取值范围**：数组长度大小不超过500，内容大小不超过500k。
	ServiceCapabilities []ServiceCapability `json:"service_capabilities"`

	// **参数说明**：厂商名称。 **取值范围**：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	ManufacturerName *string `json:"manufacturer_name,omitempty"`

	// **参数说明**：设备所属行业。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	Industry *string `json:"industry,omitempty"`

	// **参数说明**：产品的描述信息。 **取值范围**：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。/等字符的组合。
	Description *string `json:"description,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的产品归属到哪个资源空间下，否则创建的产品将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`
}

创建产品信息结构体。

func (AddProduct) String 

func (o AddProduct) String() string

type AddQueueRequest 

type AddQueueRequest struct {

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

	Body *QueueInfo `json:"body,omitempty"`
}

Request Object

func (AddQueueRequest) String 

func (o AddQueueRequest) String() string

type AddQueueResponse 

type AddQueueResponse struct {

	// 队列ID，用于唯一标识一个队列。
	QueueId *string `json:"queue_id,omitempty"`

	// 队列名称，同一租户不允许重复。
	QueueName *string `json:"queue_name,omitempty"`

	// 在物联网平台创建队列的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 在物联网平台最后修改队列的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	LastModifyTime *string `json:"last_modify_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (AddQueueResponse) String 

func (o AddQueueResponse) String() string

type AddRuleReq 

type AddRuleReq struct {

	// **参数说明**：规则名称。 **取值范围**：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合
	RuleName *string `json:"rule_name,omitempty"`

	// **参数说明**：用户自定义的规则描述。
	Description *string `json:"description,omitempty"`

	Subject *RoutingRuleSubject `json:"subject"`

	// **参数说明**：租户规则的生效范围，默认GLOBAL，。 **取值范围**： - GLOBAL：生效范围为租户级。 - APP：生效范围为资源空间级。如果类型为APP，创建的规则生效范围为携带的app_id指定的资源空间，不携带app_id则创建规则生效范围为[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)。
	AppType *string `json:"app_type,omitempty"`

	// **参数说明**：资源空间ID。。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：用户自定义sql select语句，最大长度2500，该参数仅供标准版和企业版用户使用。可填参数可参考帮助文档数据下各接口的请求参数，如notify_data.body。
	Select *string `json:"select,omitempty"`

	// **参数说明**：用户自定义sql where语句，最大长度2500，该参数仅供标准版和企业版用户使用可填参数可参考帮助文档数据下各接口的请求参数，如notify_data.body。
	Where *string `json:"where,omitempty"`
}

规则触发条件请求结构体

func (AddRuleReq) String 

func (o AddRuleReq) String() string

type AmqpForwarding 

type AmqpForwarding struct {

	// **参数说明**：用于接收满足规则条件数据的amqp queue。
	QueueName string `json:"queue_name"`
}

amqp queue配置信息

func (AmqpForwarding) String 

func (o AmqpForwarding) String() string

type ApplicationDto 

type ApplicationDto struct {

	// 资源空间ID，唯一标识一个资源空间，由物联网平台在创建资源空间时分配。资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 资源空间创建时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 是否为默认资源空间
	DefaultApp *bool `json:"default_app,omitempty"`
}

资源空间详情结构体。

func (ApplicationDto) String 

func (o ApplicationDto) String() string

type AsyncDeviceCommandRequest 

type AsyncDeviceCommandRequest struct {

	// **参数说明**：设备命令所属的设备服务ID，在设备关联的产品模型中定义。如设备需要编解码插件来解析命令，此参数为必填项。 **取值范围**：长度不超过64的字符串。
	ServiceId *string `json:"service_id,omitempty"`

	// **参数说明**：设备命令名称，在设备关联的产品模型中定义。如设备需要编解码插件来解析命令，此参数为必填项。 **取值范围**：长度不超过128的字符串。
	CommandName *string `json:"command_name,omitempty"`

	// **参数说明**：设备执行的命令，Json格式，里面是一个个健值对，如果service_id不为空，每个健都是profile中命令的参数名（paraName）;如果service_id为空则由用户自定义命令格式。设备命令示例：{\"value\":\"1\"}，具体格式需要应用和设备约定， 最大32K。
	Paras *interface{} `json:"paras"`

	// **参数说明**：物联网平台缓存命令的时长， 单位秒, 平台最多缓存20条消息（即最多缓存20条PENDING状态的命令） 该参数在send_strategy字段为delay时有效，默认缓存24小时，最大缓存2天。
	ExpireTime *int32 `json:"expire_time,omitempty"`

	// **参数说明**：下发策略，默认缓存下发。 **取值范围**： - immediately:表示立即下发，此时expire_time无效。 - delay:表示缓存下发，等数据上报或者设备上线之后下发。expire_time为0或空时，命令会默认缓存24小时。
	SendStrategy string `json:"send_strategy"`
}

func (AsyncDeviceCommandRequest) String 

func (o AsyncDeviceCommandRequest) String() string

type AuthInfo 

type AuthInfo struct {

	// **参数说明**：鉴权类型。注意：不填写auth_type默认为密钥认证接入方式(SECRET)。 **取值范围**： - SECRET:使用密钥认证接入方式。 - CERTIFICATES:使用证书认证接入方式。
	AuthType *string `json:"auth_type,omitempty"`

	// **参数说明**：设备密钥，认证类型使用密钥认证接入(SECRET)可填写该字段。注意：NB设备密钥由于协议特殊性，只支持十六进制密钥接入；查询设备列表接口不返回该参数。 **取值范围**：长度不低于8不超过32，只允许字母、数字、下划线（_）、连接符（-）的组合。
	Secret *string `json:"secret,omitempty"`

	// **参数说明**：证书指纹，认证类型使用证书认证接入(CERTIFICATES)可填写该字段，注册设备时不填写该字段则取第一次设备接入时的证书指纹。 **取值范围**：长度为40的十六进制字符串或者长度为64的十六进制字符串。
	Fingerprint *string `json:"fingerprint,omitempty"`

	// **参数说明**：指设备是否通过安全协议方式接入。 **取值范围**： - true：通过安全协议方式接入。 - false：通过非安全协议方式接入。非安全接入的设备存在被仿冒等安全风险，请谨慎使用。
	SecureAccess *bool `json:"secure_access,omitempty"`

	// **参数说明**：设备接入的有效时间，单位：秒，默认值：0 若设备在有效时间内未接入物联网平台并激活，则平台会删除该设备的注册信息。若设置为“0”，则表示平台不会删除该设备的注册信息（建议填写为“0”）。 注意：只有注册设备接口或者修改设备接口修改timeout时返回该参数。
	Timeout *int32 `json:"timeout,omitempty"`
}

设备接入类型。

func (AuthInfo) String 

func (o AuthInfo) String() string

type AuthInfoWithoutSecret 

type AuthInfoWithoutSecret struct {

	// **参数说明**：指设备是否通过安全协议方式接入。 **取值范围**： - true：通过安全协议方式接入。 - false：通过非安全协议方式接入。非安全接入的设备存在被仿冒等安全风险，请谨慎使用。
	SecureAccess *bool `json:"secure_access,omitempty"`

	// **参数说明**：设备接入的有效时间，单位：秒，默认值：0。若设备在有效时间内未接入物联网平台并激活，则平台会删除该设备的注册信息。若设置为“0”，则表示平台不会删除该设备的注册信息（建议填写为“0”）。
	Timeout *int32 `json:"timeout,omitempty"`
}

设备接入类型不返回密钥模式。

func (AuthInfoWithoutSecret) String 

func (o AuthInfoWithoutSecret) String() string

type BatchShowQueueRequest 

type BatchShowQueueRequest struct {

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

	// **参数说明**：amqp队列名称，支持模糊查询，为空查询所有的队列（当前规格单个用户最大100个队列）。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）、间隔号（.）、冒号（:）的组合。
	QueueName *string `json:"queue_name,omitempty"`

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从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。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (BatchShowQueueRequest) String 

func (o BatchShowQueueRequest) String() string

type BatchShowQueueResponse 

type BatchShowQueueResponse struct {

	// 队列信息列表。
	Queues *[]QueryQueueBase `json:"queues,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (BatchShowQueueResponse) String 

func (o BatchShowQueueResponse) String() string

type BatchTargetResult added in v0.1.43 

type BatchTargetResult struct {

	// 执行批量任务的目标。
	Target *string `json:"target,omitempty"`

	// 目标的执行结果，为success或failure
	Status *string `json:"status,omitempty"`

	// 操作失败的错误码
	ErrorCode *string `json:"error_code,omitempty"`

	// 操作失败的错误描述
	ErrorMsg *string `json:"error_msg,omitempty"`
}

批量操作目标结果

func (BatchTargetResult) String added in v0.1.43 

func (o BatchTargetResult) String() string

type BatchTargets added in v0.1.43 

type BatchTargets struct {

	// 执行批量任务的目标集合，最多支持100个目标，当task_type为firmwareUpgrade，softwareUpgrade时，此处填写device_id
	Targets *[]string `json:"targets,omitempty"`
}

批量操作的目标集合

func (BatchTargets) String added in v0.1.43 

func (o BatchTargets) String() string

type BatchTaskFile 

type BatchTaskFile struct {

	// 上传的批量任务文件ID，由平台自动生成。
	FileId *string `json:"file_id,omitempty"`

	// 上传的批量任务文件名称。
	FileName *string `json:"file_name,omitempty"`

	// 在物联网平台上传文件的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	UploadTime *string `json:"upload_time,omitempty"`
}

查询上传的批量任务文件结构体。

func (BatchTaskFile) String 

func (o BatchTaskFile) String() string

type BindTagsDto 

type BindTagsDto struct {

	// **参数说明**：要绑定标签的资源类型。 **取值范围**： - device：设备。
	ResourceType string `json:"resource_type"`

	// **参数说明**：要绑定标签的资源id。例如，资源类型为device，那么对应的资源id就是device_id。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ResourceId string `json:"resource_id"`

	// **参数说明**：要绑定到指定资源的标签列表，标签列表中各项标签键值之间不允许重复，一个资源最多可以绑定10个标签。
	Tags []TagV5Dto `json:"tags"`
}

创建标签请求结构体。

func (BindTagsDto) String 

func (o BindTagsDto) String() string

type BroadcastMessageRequest added in v0.1.37 

type BroadcastMessageRequest struct {

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

	Body *DeviceBroadcastRequest `json:"body,omitempty"`
}

Request Object

func (BroadcastMessageRequest) String added in v0.1.37 

func (o BroadcastMessageRequest) String() string

type BroadcastMessageResponse added in v0.1.37 

type BroadcastMessageResponse struct {

	// **参数说明**：资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：接收广播消息的完整Topic名称
	TopicFullName *string `json:"topic_full_name,omitempty"`

	// 消息id，由物联网平台生成，用于标识该消息。
	MessageId *string `json:"message_id,omitempty"`

	// 消息的创建时间，\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串。
	CreatedTime    *string `json:"created_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (BroadcastMessageResponse) String added in v0.1.37 

func (o BroadcastMessageResponse) String() string

type CertificatesRspDto 

type CertificatesRspDto struct {

	// CA证书ID，在上传CA证书时由平台分配的唯一标识。
	CertificateId *string `json:"certificate_id,omitempty"`

	// CA证书CN名称。
	CnName *string `json:"cn_name,omitempty"`

	// CA证书所有者。
	Owner *string `json:"owner,omitempty"`

	// CA证书验证状态。true代表证书已通过验证，可进行设备证书认证接入。false代表证书未通过验证。
	Status *bool `json:"status,omitempty"`

	// CA证书验证码。
	VerifyCode *string `json:"verify_code,omitempty"`

	// 创建证书日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateDate *string `json:"create_date,omitempty"`

	// CA证书生效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	EffectiveDate *string `json:"effective_date,omitempty"`

	// CA证书失效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	ExpiryDate *string `json:"expiry_date,omitempty"`
}

func (CertificatesRspDto) String 

func (o CertificatesRspDto) String() string

type ChangeRuleStatusRequest 

type ChangeRuleStatusRequest struct {

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

	// **参数说明**：规则Id。 **取值范围**：长度不超过32，只允许字母、数字的组合。
	RuleId string `json:"rule_id"`

	Body *RuleStatus `json:"body,omitempty"`
}

Request Object

func (ChangeRuleStatusRequest) String 

func (o ChangeRuleStatusRequest) String() string

type ChangeRuleStatusResponse 

type ChangeRuleStatusResponse struct {

	// **参数说明**：规则的激活状态。 **取值范围**： - active：激活。 - inactive：未激活。
	Status         *string `json:"status,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ChangeRuleStatusResponse) String 

func (o ChangeRuleStatusResponse) String() string

type ChannelDetail 

type ChannelDetail struct {
	HttpForwarding *HttpForwarding `json:"http_forwarding,omitempty"`

	DisForwarding *DisForwarding `json:"dis_forwarding,omitempty"`

	ObsForwarding *ObsForwarding `json:"obs_forwarding,omitempty"`

	AmqpForwarding *AmqpForwarding `json:"amqp_forwarding,omitempty"`

	DmsKafkaForwarding *DmsKafkaForwarding `json:"dms_kafka_forwarding,omitempty"`

	RomaForwarding *RomaForwarding `json:"roma_forwarding,omitempty"`

	MysqlForwarding *MysqlForwarding `json:"mysql_forwarding,omitempty"`

	InfluxdbForwarding *InfluxDbForwarding `json:"influxdb_forwarding,omitempty"`

	FunctiongraphForwarding *FunctionGraphForwarding `json:"functiongraph_forwarding,omitempty"`

	MrsKafkaForwarding *MrsKafkaForwarding `json:"mrs_kafka_forwarding,omitempty"`

	DmsRocketmqForwarding *DmsRocketMqForwarding `json:"dms_rocketmq_forwarding,omitempty"`
}

物联网平台转发数据的通道配置参数。

func (ChannelDetail) String 

func (o ChannelDetail) String() string

type CheckCertificateRequest 

type CheckCertificateRequest struct {

	// Sp用户Token。通过调用IoBPS服务获取SP用户Token
	SpAuthToken *string `json:"Sp-Auth-Token,omitempty"`

	// Stage用户的Token, 仅提供给IoStage服务使用
	StageAuthToken *string `json:"Stage-Auth-Token,omitempty"`

	// 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	// 设备CA证书ID，在上传设备CA证书时由平台分配的唯一标识。
	CertificateId string `json:"certificate_id"`

	// 对证书执行的操作，当前仅支持verify:校验证书
	ActionId string `json:"action_id"`

	Body *VerifyCertificateDto `json:"body,omitempty"`
}

Request Object

func (CheckCertificateRequest) String 

func (o CheckCertificateRequest) String() string

type CheckCertificateResponse 

type CheckCertificateResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CheckCertificateResponse) String 

func (o CheckCertificateResponse) String() string

type Cmd 

type Cmd struct {

	// **参数说明**：设备命令名称，在设备关联的产品模型中定义。
	CommandName string `json:"command_name"`

	// **参数说明**：设备命令参数，Json格式。 使用LWM2M协议设备命令示例：{\"value\":\"1\"}，里面是一个个键值对，每个键都是产品模型中命令的参数名（paraName）。 使用MQTT协议设备命令示例：{\"header\": {\"mode\": \"ACK\",\"from\": \"/users/testUser\",\"method\": \"SET_TEMPERATURE_READ_PERIOD\",\"to\":\"/devices/{device_id}/services/{service_id}\"},\"body\": {\"value\" : \"1\"}}。 - mode：必选，设备收到命令后是否需要回复确认消息，默认为ACK模式。ACK表示需要回复确认消息，NOACK表示不需要回复确认消息，其它值无效。 - from：可选，命令发送方的地址。App发起请求时格式为/users/{userId} ，应用服务器发起请求时格式为/{serviceName}，物联网平台发起请求时格式为/cloud/{serviceName}。 - to：可选，命令接收方的地址，格式为/devices/{device_id}/services/{service_id}。 - method：可选，产品模型中定义的命令名称。 - body：可选，命令的消息体，里面是一个个键值对，每个键都是产品模型中命令的参数名（paraName）。具体格式需要应用和设备约定。
	CommandBody *interface{} `json:"command_body"`

	// **参数说明**：设备命令所属的设备服务ID，在设备关联的产品模型中定义。
	ServiceId string `json:"service_id"`

	// **参数说明**：设备命令的缓存时间，单位为秒，表示物联网平台在把命令下发给设备前缓存命令的有效时间，超过这个时间后命令将不再下发，默认值为172800s（48小时）。 如果buffer_timeout设置为0，则无论物联网平台上设置的命令下发模式是什么，该命令都会立即下发给设备。
	BufferTimeout *int32 `json:"buffer_timeout,omitempty"`

	// **参数说明**：命令响应的有效时间，单位为秒，表示设备接收到命令后，在response_timeout时间内响应有效，超过这个时间未收到命令的响应，则认为命令响应超时，默认值为1800s。
	ResponseTimeout *int32 `json:"response_timeout,omitempty"`

	// **参数说明**：设备命令的下发模式，仅当buffer_timeout的值大于0时有效。 - ACTIVE：主动模式，物联网平台主动将命令下发给设备。 - PASSIVE：被动模式，物联网平台创建设备命令后，会直接缓存命令。等到设备再次上线或者上报上一条命令的执行结果后才下发命令。
	Mode *string `json:"mode,omitempty"`
}

给设备下发命令的命令内容，在动作的type为“DEVICE_CMD”时有效，且为必选

func (Cmd) String 

func (o Cmd) String() string

type ColumnMapping 

type ColumnMapping struct {

	// **参数说明**：数据库的列名
	ColumnName string `json:"column_name"`

	// **参数说明**：流转数据的属性名
	JsonKey string `json:"json_key"`
}

数据库的列和流转数据的对应关系。

func (ColumnMapping) String 

func (o ColumnMapping) String() string

type ConditionGroup 

type ConditionGroup struct {

	// **参数说明**：规则的条件列表，单个规则最多支持设置10个条件。
	Conditions *[]RuleCondition `json:"conditions,omitempty"`

	// **参数说明**：规则条件列表中多个条件之间的逻辑关系，默认值：and。 **取值范围**： - and：逻辑且。 - or：逻辑或。
	Logic *string `json:"logic,omitempty"`

	TimeRange *TimeRange `json:"time_range,omitempty"`
}

规则条件组

func (ConditionGroup) String 

func (o ConditionGroup) String() string

type CreateAccessCodeRequest 

type CreateAccessCodeRequest struct {

	// **参数说明**：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	Body *CreateAccessCodeRequestBody `json:"body,omitempty"`
}

Request Object

func (CreateAccessCodeRequest) String 

func (o CreateAccessCodeRequest) String() string

type CreateAccessCodeRequestBody 

type CreateAccessCodeRequestBody struct {

	// **参数说明**：接入凭证类型，默认为AMQP的接入凭证类型。 **取值范围**： - [AMQP,MQTT]
	Type *string `json:"type,omitempty"`
}

生成接入凭证的结构体。

func (CreateAccessCodeRequestBody) String 

func (o CreateAccessCodeRequestBody) String() string

type CreateAccessCodeResponse 

type CreateAccessCodeResponse struct {

	// 接入名，随机生成8位字符串
	AccessKey *string `json:"access_key,omitempty"`

	// 接入凭证。
	AccessCode     *string `json:"access_code,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateAccessCodeResponse) String 

func (o CreateAccessCodeResponse) String() string

type CreateAsyncCommandRequest 

type CreateAsyncCommandRequest struct {

	// **参数说明**：下发命令的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

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

	Body *AsyncDeviceCommandRequest `json:"body,omitempty"`
}

Request Object

func (CreateAsyncCommandRequest) String 

func (o CreateAsyncCommandRequest) String() string

type CreateAsyncCommandResponse 

type CreateAsyncCommandResponse struct {

	// 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。
	CommandId *string `json:"command_id,omitempty"`

	// 设备命令所属的设备服务ID，在设备关联的产品模型中定义。
	ServiceId *string `json:"service_id,omitempty"`

	// 设备命令名称，在设备关联的产品模型中定义。
	CommandName *string `json:"command_name,omitempty"`

	// 设备执行的命令，Json格式，里面是一个个健值对，如果service_id不为空，每个健都是profile中命令的参数名（paraName）;如果service_id为空则由用户自定义命令格式。设备命令示例：{\"value\":\"1\"}，具体格式需要应用和设备约定。
	Paras *interface{} `json:"paras,omitempty"`

	// 物联网平台缓存命令的时长， 单位秒。
	ExpireTime *int32 `json:"expire_time,omitempty"`

	// 设备命令状态,如果命令被缓存，返回PENDING, 如果命令下发给设备，返回SENT。
	Status *string `json:"status,omitempty"`

	// 命令的创建时间，\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串。
	CreatedTime *string `json:"created_time,omitempty"`

	// 下发策略， immediately表示立即下发，delay表示缓存起来，等数据上报或者设备上线之后下发。
	SendStrategy   *string `json:"send_strategy,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateAsyncCommandResponse) String 

func (o CreateAsyncCommandResponse) String() string

type CreateBatchTask 

type CreateBatchTask struct {

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的批量任务归属到哪个资源空间下，否则创建的批量任务将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：批量任务名称。 **取值范围**：长度不超过128，只允许中文、字母、数字、下划线（_）的组合。
	TaskName string `json:"task_name"`

	// **参数说明**：批量任务类型。 **取值范围**： - softwareUpgrade: 软件升级任务 - firmwareUpgrade: 固件升级任务 - createDevices: 批量创建设备任务 - deleteDevices: 批量删除设备任务 - freezeDevices: 批量冻结设备任务 - unfreezeDevices: 批量解冻设备任务 - createCommands: 批量创建同步命令任务 - createAsyncCommands: 批量创建异步命令任务 - createMessages: 批量创建消息任务 - updateDeviceShadows：批量配置设备影子任务 - updateDevices：批量更新设备任务
	TaskType string `json:"task_type"`

	// **参数说明**：执行批量任务的目标，此处填写device_id列表，且最多支持3万个device_id。当task_type为firmwareUpgrade，softwareUpgrade，deleteDevices，freezeDevices，unfreezeDevices，createCommands，createAsyncCommands，createMessages，updateDeviceShadows，支持该参数。同时使用targets、targets_filter、document_source参数时，只有一个参数会生效，且平台优先使用targets，其次是targets_filter，最后是document_source。 **取值范围**：device_id列表。device_id支持长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	Targets *[]string `json:"targets,omitempty"`

	// **参数说明**：任务目标筛选参数。Json格式，里面是一个个键值对，（K,V）格式标识筛选targets需要的参数，目前支持的K有group_ids（V填写group_id数组，eg:[\"e495cf17-ff79-4294-8f64-4d367919d665\"]，任务则会筛选出来符合该群组条件的设备作为目标）。当task_type为firmwareUpgrade，softwareUpgrade，deleteDevices，freezeDevices，unfreezeDevices，createCommands，createAsyncCommands，createMessages，updateDeviceShadows，支持该参数。同时使用targets、targets_filter、document_source参数时，只有一个参数会生效，且平台优先使用targets，其次是targets_filter，最后是document_source。
	TargetsFilter map[string]interface{} `json:"targets_filter,omitempty"`

	// **参数说明**：执行任务数据文档，Json格式，Json里面是(K,V)键值对。当task_type为firmwareUpgrade，softwareUpgrade，createCommands，createAsyncCommands，createMessages，updateDeviceShadows，支持该参数。 - softwareUpgrade|firmwareUpgrade，需要填写key为package_id，value为在平台上传的软固件附件id，id由portal软件库包管理上传并查询获得。eg：“{\"package_id\": \"32822e5744a45ede319d2c50\"}”。 - createCommands，需要填写同步命令相关参数，eg：“{\"service_id\":\"water\",\"command_name\":\"ON_OFF\",\"paras\":{\"value\":\"ON\"}}”，参考[[设备同步命令](https://support.huaweicloud.com/api-iothub/iot_06_v5_0038.html)](tag:hws)[[设备同步命令](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0038.html)](tag:hws_hk))。 - createAsyncCommands，需要填写异步命令相关参数，eg：“{\"service_id\":\"water\",\"command_name\":\"ON_OFF\",\"paras\":{\"value\":\"ON\"},\"expire_time\":0,\"send_strategy\":\"immediately\"}”，参考[[设备异步命令](https://support.huaweicloud.com/api-iothub/iot_06_v5_0040.html)](tag:hws)[[设备异步命令](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0040.html)](tag:hws_hk))。 - createMessages，需要填写消息下发相关参数，eg：“{\"message_id\":\"99b32da9-cd17-4cdf-a286-f6e849cbc364\",\"name\":\"messageName\",\"message\":\"HelloWorld\",\"encoding\":\"none\",\"payload_format\":\"standard\",\"topic\":\"messageDown\",\"topic_full_name\":\"/device/message/down\"}”，参考[[下发设备消息](https://support.huaweicloud.com/api-iothub/iot_06_v5_0059.html)](tag:hws)[[下发设备消息](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0059.html)](tag:hws_hk))。 - updateDeviceShadows，需要填写配置设备影子相关参数，eg：“{\"shadow\": [{\"service_id\": \"WaterMeter\",\"desired\": {\"temperature\": \"60\"}}]}”，参考[[配置设备影子预期数据](https://support.huaweicloud.com/api-iothub/iot_06_v5_0072.html)](tag:hws)[[配置设备影子预期数据](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0072.html)](tag:hws_hk))。限制说明：1. service_id和desired参数必填。2. 配置的service_id数量不大于5个且service_id不能重复。3. 配置参数内容大小不超过10K。
	Document *interface{} `json:"document,omitempty"`

	TaskPolicy *TaskPolicy `json:"task_policy,omitempty"`

	// **参数说明**：上传的批量任务文件ID。当task_type为createDevices，updateDevices，deleteDevices，freezeDevices，unfreezeDevices时，支持该参数。使用该参数时，需要先调用批量任务的文件管理接口上传文件来获取文件ID，文件样例请参见 [批量注册设备模板](https://iot-developer.obs.cn-north-4.myhuaweicloud.com/IoTM/2023-3/BatchCreateDevices_Template.xlsx)，[批量更新设备模板](https://iot-developer.obs.cn-north-4.myhuaweicloud.com/IoTM/2023-3/BatchUpdateDevices_Template.xlsx)，[批量删除设备模板](https://developer.obs.cn-north-4.myhuaweicloud.com/template/BatchDeleteDevices_Template.xlsx)，[批量冻结设备模板](https://developer.obs.cn-north-4.myhuaweicloud.com/template/BatchFreezeDevices_Template.xlsx)，[批量解冻设备模板](https://developer.obs.cn-north-4.myhuaweicloud.com/template/BatchUnfreezeDevices_Template.xlsx)。同时使用targets、targets_filter、document_source参数时，只有一个参数会生效，且平台优先使用targets，其次是targets_filter，最后是document_source。
	DocumentSource *string `json:"document_source,omitempty"`
}

添加任务结构体

func (CreateBatchTask) String 

func (o CreateBatchTask) String() string

type CreateBatchTaskRequest 

type CreateBatchTaskRequest struct {

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

	Body *CreateBatchTask `json:"body,omitempty"`
}

Request Object

func (CreateBatchTaskRequest) String 

func (o CreateBatchTaskRequest) String() string

type CreateBatchTaskResponse 

type CreateBatchTaskResponse struct {

	// 批量任务ID，创建批量任务时由物联网平台分配获得。
	TaskId *string `json:"task_id,omitempty"`

	// 批量任务名称。
	TaskName *string `json:"task_name,omitempty"`

	// 批量任务类型，取值范围：firmwareUpgrade，softwareUpgrade，createDevices，deleteDevices，freezeDevices，unfreezeDevices，createCommands，createAsyncCommands，createMessages，updateDeviceShadows。 - softwareUpgrade: 软件升级任务 - firmwareUpgrade: 固件升级任务 - createDevices: 批量创建设备任务 - deleteDevices: 批量删除设备任务 - freezeDevices: 批量冻结设备任务 - unfreezeDevices: 批量解冻设备任务 - createCommands: 批量创建同步命令任务 - createAsyncCommands: 批量创建异步命令任务 - createMessages: 批量创建消息任务 - updateDeviceShadows: 批量配置设备影子任务 - updateDevices：批量更新设备任务
	TaskType *string `json:"task_type,omitempty"`

	// 执行批量任务的目标，当task_type为firmwareUpgrade，softwareUpgrade，deleteDevices，freezeDevices，unfreezeDevices，createCommands，createAsyncCommands，createMessages，updateDeviceShadows，此处填写device_id列表。
	Targets *[]string `json:"targets,omitempty"`

	// 任务目标筛选参数。Json格式，里面是一个个键值对，（K,V）格式标识筛选targets需要的参数，目前支持的K有group_ids（V填写group_id数组，eg:[\"e495cf17-ff79-4294-8f64-4d367919d665\"]，任务则会筛选出来符合该群组条件的设备作为目标）
	TargetsFilter map[string]interface{} `json:"targets_filter,omitempty"`

	// 执行任务数据文档，Json格式。(当task_type为softwareUpgrade|firmwareUpgrade，也就是软固件升级任务时，Json里面是(K,V)键值对，需要填写key为package_id，value为在平台上传的软固件附件id，id由portal软件库包管理上传并查询获得。当task_type为createCommands，也就是批量创建同步命令任务时，Json里面是命令相关参数，eg：{\"service_id\":\"water\",\"command_name\":\"ON_OFF\",\"paras\":{\"value\":\"ON\"}}，参考[[设备同步命令](https://support.huaweicloud.com/api-iothub/iot_06_v5_0038.html)](tag:hws)[[设备同步命令](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0038.html)](tag:hws_hk))。当task_type为createAsyncCommands，也就是批量创建异步命令任务时，Json里面是命令相关参数，eg：{\"service_id\":\"water\",\"command_name\":\"ON_OFF\",\"paras\":{\"value\":\"ON\"},\"expire_time\":0,\"send_strategy\":\"immediately\"}，参考[[设备异步命令](https://support.huaweicloud.com/api-iothub/iot_06_v5_0040.html)](tag:hws)[[设备异步命令](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0040.html)](tag:hws_hk))。当task_type为updateDeviceShadows，也就是批量配置设备影子任务时，Json里面是命令相关参数，eg：{\"shadow\": [{\"service_id\": \"WaterMeter\",\"desired\": {\"temperature\": \"60\"}}]}，参考[[配置设备影子预期数据](https://support.huaweicloud.com/api-iothub/iot_06_v5_0072.html)](tag:hws)[[配置设备影子预期数据](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0072.html)](tag:hws_hk))。
	Document *interface{} `json:"document,omitempty"`

	TaskPolicy *TaskPolicy `json:"task_policy,omitempty"`

	// 批量任务的状态，可选参数，取值范围：Success|Fail|Processing|PartialSuccess|Stopped|Waitting|Initializing|Stopping。 - Initializing: 初始化中。 - Waitting: 等待中。 - Processing: 执行中。 - Success: 成功。 - Fail: 失败。 - PartialSuccess: 部分成功。 - Stopped: 停止。 - Stopping 停止中。
	Status *string `json:"status,omitempty"`

	// 批量任务状态描述(包含主任务失败错误信息)
	StatusDesc *string `json:"status_desc,omitempty"`

	TaskProgress *TaskProgress `json:"task_progress,omitempty"`

	// 批量任务的创建时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime     *string `json:"create_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateBatchTaskResponse) String 

func (o CreateBatchTaskResponse) String() string

type CreateCertificateDto 

type CreateCertificateDto struct {

	// 证书内容信息。
	Content string `json:"content"`

	// 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的证书归属到哪个资源空间下，否则创建的证书将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。
	AppId *string `json:"app_id,omitempty"`
}

创建CA证书结构体。

func (CreateCertificateDto) String 

func (o CreateCertificateDto) String() string

type CreateCommandRequest 

type CreateCommandRequest struct {

	// **参数说明**：下发消息的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

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

	Body *DeviceCommandRequest `json:"body,omitempty"`
}

Request Object

func (CreateCommandRequest) String 

func (o CreateCommandRequest) String() string

type CreateCommandResponse 

type CreateCommandResponse struct {

	// 设备命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。
	CommandId *string `json:"command_id,omitempty"`

	// 设备上报的命令执行结果。Json格式，具体格式需要应用和设备约定。
	Response       *interface{} `json:"response,omitempty"`
	HttpStatusCode int          `json:"-"`
}

Response Object

func (CreateCommandResponse) String 

func (o CreateCommandResponse) String() string

type CreateMessageRequest 

type CreateMessageRequest struct {

	// **参数说明**：下发消息的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

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

	Body *DeviceMessageRequest `json:"body,omitempty"`
}

Request Object

func (CreateMessageRequest) String 

func (o CreateMessageRequest) String() string

type CreateMessageResponse 

type CreateMessageResponse struct {

	// 消息id，由用户生成（推荐使用UUID），同一个设备下唯一， 如果用户不填写，则由物联网平台生成。
	MessageId *string `json:"message_id,omitempty"`

	Result         *MessageResult `json:"result,omitempty"`
	HttpStatusCode int            `json:"-"`
}

Response Object

func (CreateMessageResponse) String 

func (o CreateMessageResponse) String() string

type CreateOrDeleteDeviceInGroupRequest 

type CreateOrDeleteDeviceInGroupRequest struct {

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

	// **参数说明**：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。 **取值范围**：长度不超过36，十六进制字符串和连接符（-）的组合
	GroupId string `json:"group_id"`

	// **参数说明**：操作类型，支持添加设备和删除设备。 **取值范围**： - addDevice: 添加设备。添加已注册的设备到指定的设备组中。 - removeDevice: 删除设备。从指定的设备组中删除设备，只是解除了设备和设备组的关系，该设备在平台仍然存在。
	ActionId string `json:"action_id"`

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`
}

Request Object

func (CreateOrDeleteDeviceInGroupRequest) String 

func (o CreateOrDeleteDeviceInGroupRequest) String() string

type CreateOrDeleteDeviceInGroupResponse 

type CreateOrDeleteDeviceInGroupResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateOrDeleteDeviceInGroupResponse) String 

func (o CreateOrDeleteDeviceInGroupResponse) String() string

type CreateOtaPackage added in v0.1.28 

type CreateOtaPackage struct {

	// **参数说明**：资源空间ID。存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的升级包归属到哪个资源空间下。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId string `json:"app_id"`

	// **参数说明**：升级包类型。 **取值范围**：软件包必须设置为：softwarePackage，固件包必须设置为：firmwarePackage。
	PackageType string `json:"package_type"`

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId string `json:"product_id"`

	// **参数说明**：升级包版本号。 **取值范围**：长度不超过256，只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	Version string `json:"version"`

	// **参数说明**：支持用于升级此版本包的设备源版本号列表。最多支持20个源版本号。 **取值范围**：源版本号列表，源版本号只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	SupportSourceVersions *[]string `json:"support_source_versions,omitempty"`

	// **参数说明**：用于描述升级包的功能等信息。 **取值范围**：长度不超过1024。
	Description *string `json:"description,omitempty"`

	// **参数说明**：推送给设备的自定义信息。添加该升级包完成，并创建升级任务后，物联网平台向设备下发升级通知时，会下发该自定义信息给设备。 **取值范围**：长度不超过4096。
	CustomInfo *string `json:"custom_info,omitempty"`

	FileLocation *FileLocation `json:"file_location"`
}

添加升级包关联到OBS对象结构体

func (CreateOtaPackage) String added in v0.1.28 

func (o CreateOtaPackage) String() string

type CreateOtaPackageRequest added in v0.1.28 

type CreateOtaPackageRequest struct {

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

	Body *CreateOtaPackage `json:"body,omitempty"`
}

Request Object

func (CreateOtaPackageRequest) String added in v0.1.28 

func (o CreateOtaPackageRequest) String() string

type CreateOtaPackageResponse added in v0.1.28 

type CreateOtaPackageResponse struct {

	// **参数说明**：升级包ID，用于唯一标识一个升级包。由物联网平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、连接符（-）的组合。
	PackageId *string `json:"package_id,omitempty"`

	// **参数说明**：资源空间ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：升级包类型。 **取值范围**：软件包必须设置为：softwarePackage，固件包必须设置为：firmwarePackage。
	PackageType *string `json:"package_type,omitempty"`

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId *string `json:"product_id,omitempty"`

	// **参数说明**：升级包版本号。 **取值范围**：长度不超过256，只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	Version *string `json:"version,omitempty"`

	// **参数说明**：支持用于升级此版本包的设备源版本号列表。最多支持20个源版本号。 **取值范围**：源版本号列表，源版本号只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	SupportSourceVersions *[]string `json:"support_source_versions,omitempty"`

	// **参数说明**：用于描述升级包的功能等信息。 **取值范围**：长度不超过1024。
	Description *string `json:"description,omitempty"`

	// **参数说明**：推送给设备的自定义信息。添加该升级包完成，并创建升级任务后，物联网平台向设备下发升级通知时，会下发该自定义信息给设备。 **取值范围**：长度不超过4096。
	CustomInfo *string `json:"custom_info,omitempty"`

	// 软固件包上传到物联网平台的时间，格式：\"yyyyMMdd'T'HHmmss'Z'\"。
	CreateTime *string `json:"create_time,omitempty"`

	FileLocation   *FileLocation `json:"file_location,omitempty"`
	HttpStatusCode int           `json:"-"`
}

Response Object

func (CreateOtaPackageResponse) String added in v0.1.28 

func (o CreateOtaPackageResponse) String() string

type CreateProductRequest 

type CreateProductRequest struct {

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

	Body *AddProduct `json:"body,omitempty"`
}

Request Object

func (CreateProductRequest) String 

func (o CreateProductRequest) String() string

type CreateProductResponse 

type CreateProductResponse struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。
	ProductId *string `json:"product_id,omitempty"`

	// 产品名称。
	Name *string `json:"name,omitempty"`

	// 设备类型。
	DeviceType *string `json:"device_type,omitempty"`

	// 设备使用的协议类型。取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF， OPC-UA，OPC-DA，Other。
	ProtocolType *string `json:"protocol_type,omitempty"`

	// 设备上报数据的格式，取值范围：json，binary。
	DataFormat *string `json:"data_format,omitempty"`

	// 厂商名称。
	ManufacturerName *string `json:"manufacturer_name,omitempty"`

	// 设备所属行业。
	Industry *string `json:"industry,omitempty"`

	// 产品的描述信息。
	Description *string `json:"description,omitempty"`

	// 设备的服务能力列表。
	ServiceCapabilities *[]ServiceCapability `json:"service_capabilities,omitempty"`

	// 在物联网平台创建产品的时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime     *string `json:"create_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateProductResponse) String 

func (o CreateProductResponse) String() string

type CreateRoutingRuleRequest 

type CreateRoutingRuleRequest struct {

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

	Body *AddRuleReq `json:"body,omitempty"`
}

Request Object

func (CreateRoutingRuleRequest) String 

func (o CreateRoutingRuleRequest) String() string

type CreateRoutingRuleResponse 

type CreateRoutingRuleResponse struct {

	// 规则触发条件ID，用于唯一标识一个规则触发条件，在创建规则条件时由物联网平台分配获得。
	RuleId *string `json:"rule_id,omitempty"`

	// 用户自定义的规则名称。
	RuleName *string `json:"rule_name,omitempty"`

	// 用户自定义的规则描述。
	Description *string `json:"description,omitempty"`

	Subject *RoutingRuleSubject `json:"subject,omitempty"`

	// 租户规则的生效范围，取值如下： - GLOBAL：生效范围为租户级 - APP：生效范围为资源空间级。
	AppType *string `json:"app_type,omitempty"`

	// 资源空间ID
	AppId *string `json:"app_id,omitempty"`

	// 用户自定义sql select语句，最大长度2500，该参数仅供标准版和企业版用户使用。
	Select *string `json:"select,omitempty"`

	// 用户自定义sql where语句，最大长度2500，该参数仅供标准版和企业版用户使用。
	Where *string `json:"where,omitempty"`

	// 规则条件的状态是否为激活。
	Active         *bool `json:"active,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (CreateRoutingRuleResponse) String 

func (o CreateRoutingRuleResponse) String() string

type CreateRuleActionRequest 

type CreateRuleActionRequest struct {

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

	Body *AddActionReq `json:"body,omitempty"`
}

Request Object

func (CreateRuleActionRequest) String 

func (o CreateRuleActionRequest) String() string

type CreateRuleActionResponse 

type CreateRuleActionResponse struct {

	// 规则动作ID，用于唯一标识一条规则动作，在创建规则动作时由物联网平台分配获得，创建时无需携带，由平台统一分配唯一的action_id。
	ActionId *string `json:"action_id,omitempty"`

	// 规则动作对应的的规则触发条件ID。
	RuleId *string `json:"rule_id,omitempty"`

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 规则动作的类型，取值范围： - HTTP_FORWARDING：HTTP服务消息类型。 - DIS_FORWARDING：转发DIS服务消息类型。 - OBS_FORWARDING：转发OBS服务消息类型。 - AMQP_FORWARDING：转发AMQP服务消息类型。 - DMS_KAFKA_FORWARDING：转发kafka消息类型。 [- ROMA_FORWARDING: 转发Roma消息类型。（仅企业版支持）](tag:hws) - INFLUXDB_FORWARDING：转发InfluxDB消息类型。[（仅标准版和企业版支持）](tag:hws) - MYSQL_FORWARDING：转发MySQL消息类型。[（仅标准版和企业版支持）](tag:hws) - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。[（仅标准版和企业版支持）](tag:hws) [- MRS_KAFKA_FORWARDING：转发MRS_KAFKA消息类型。（仅企业版支持）](tag:hws) [- DMS_ROCKETMQ_FORWARDING：转发RocketMQ消息类型。（仅标准版和企业版支持）](tag:hws)
	Channel *string `json:"channel,omitempty"`

	ChannelDetail  *ChannelDetail `json:"channel_detail,omitempty"`
	HttpStatusCode int            `json:"-"`
}

Response Object

func (CreateRuleActionResponse) String 

func (o CreateRuleActionResponse) String() string

type CreateRuleRequest 

type CreateRuleRequest struct {

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

	Body *Rule `json:"body,omitempty"`
}

Request Object

func (CreateRuleRequest) String 

func (o CreateRuleRequest) String() string

type CreateRuleResponse 

type CreateRuleResponse struct {

	// 规则id。
	RuleId *string `json:"rule_id,omitempty"`

	// 规则名称。
	Name *string `json:"name,omitempty"`

	// 规则的描述信息。
	Description *string `json:"description,omitempty"`

	ConditionGroup *ConditionGroup `json:"condition_group,omitempty"`

	// 规则的动作列表，单个规则最多支持设置10个动作。
	Actions *[]RuleAction `json:"actions,omitempty"`

	// 规则的类型 - DEVICE_LINKAGE：云端联动规则。 - DEVICE_SIDE：端侧规则。
	RuleType *string `json:"rule_type,omitempty"`

	// 规则的状态，默认值：active。 - active：激活。 - inactive：未激活。
	Status *string `json:"status,omitempty"`

	// 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的规则归属到哪个资源空间下，否则创建的规则将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。
	AppId *string `json:"app_id,omitempty"`

	// 归属边缘侧节点设备ID列表。
	EdgeNodeIds *[]string `json:"edge_node_ids,omitempty"`

	// 规则最后更新时间，使用UTC时区，格式：yyyyMMdd'T'HHmmss'Z'。
	LastUpdateTime *string `json:"last_update_time,omitempty"`

	DeviceSide     *DeviceSide `json:"device_side,omitempty"`
	HttpStatusCode int         `json:"-"`
}

Response Object

func (CreateRuleResponse) String 

func (o CreateRuleResponse) String() string

type DailyTimerType 

type DailyTimerType struct {

	// **参数说明**：规则触发的时间，格式：HH:MM。
	Time string `json:"time"`

	// **参数说明**：星期列表，以逗号分隔。1代表周日，2代表周一，依次类推，默认为每天。
	DaysOfWeek *string `json:"days_of_week,omitempty"`
}

条件中每日定时类型的信息，自定义结构。

func (DailyTimerType) String 

func (o DailyTimerType) String() string

type DeleteApplicationRequest 

type DeleteApplicationRequest struct {

	// **参数说明**：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	// **参数说明**：资源空间ID，唯一标识一个资源空间，由物联网平台在创建资源空间时分配。资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId string `json:"app_id"`
}

Request Object

func (DeleteApplicationRequest) String 

func (o DeleteApplicationRequest) String() string

type DeleteApplicationResponse 

type DeleteApplicationResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteApplicationResponse) String 

func (o DeleteApplicationResponse) String() string

type DeleteBatchTaskFileRequest 

type DeleteBatchTaskFileRequest struct {

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

	// **参数说明**：要删除的批量任务文件ID。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	FileId string `json:"file_id"`
}

Request Object

func (DeleteBatchTaskFileRequest) String 

func (o DeleteBatchTaskFileRequest) String() string

type DeleteBatchTaskFileResponse 

type DeleteBatchTaskFileResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteBatchTaskFileResponse) String 

func (o DeleteBatchTaskFileResponse) String() string

type DeleteCertificateRequest 

type DeleteCertificateRequest struct {

	// Sp用户Token。通过调用IoBPS服务获取SP用户Token
	SpAuthToken *string `json:"Sp-Auth-Token,omitempty"`

	// Stage用户的Token, 仅提供给IoStage服务使用
	StageAuthToken *string `json:"Stage-Auth-Token,omitempty"`

	// 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	// 设备CA证书ID，在上传设备CA证书时由平台分配的唯一标识。
	CertificateId string `json:"certificate_id"`
}

Request Object

func (DeleteCertificateRequest) String 

func (o DeleteCertificateRequest) String() string

type DeleteCertificateResponse 

type DeleteCertificateResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteCertificateResponse) String 

func (o DeleteCertificateResponse) String() string

type DeleteDeviceGroupRequest 

type DeleteDeviceGroupRequest struct {

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

	// **参数说明**：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。 **取值范围**：长度不超过36，十六进制字符串和连接符（-）的组合。
	GroupId string `json:"group_id"`
}

Request Object

func (DeleteDeviceGroupRequest) String 

func (o DeleteDeviceGroupRequest) String() string

type DeleteDeviceGroupResponse 

type DeleteDeviceGroupResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteDeviceGroupResponse) String 

func (o DeleteDeviceGroupResponse) String() string

type DeleteDeviceRequest 

type DeleteDeviceRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`
}

Request Object

func (DeleteDeviceRequest) String 

func (o DeleteDeviceRequest) String() string

type DeleteDeviceResponse 

type DeleteDeviceResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteDeviceResponse) String 

func (o DeleteDeviceResponse) String() string

type DeleteOtaPackageRequest added in v0.1.28 

type DeleteOtaPackageRequest struct {

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

	// **参数说明**：升级包ID，用于唯一标识一个升级包。由物联网平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、连接符（-）的组合。
	PackageId string `json:"package_id"`
}

Request Object

func (DeleteOtaPackageRequest) String added in v0.1.28 

func (o DeleteOtaPackageRequest) String() string

type DeleteOtaPackageResponse added in v0.1.28 

type DeleteOtaPackageResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteOtaPackageResponse) String added in v0.1.28 

func (o DeleteOtaPackageResponse) String() string

type DeleteProductRequest 

type DeleteProductRequest struct {

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

	// **参数说明**：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId string `json:"product_id"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数，指定要删除的产品属于哪个资源空间；若不携带，则优先删除默认资源空间下产品，如默认资源空间下无对应产品，则按照产品创建时间删除最早创建产品。如果用户存在多资源空间，同时又不想携带该参数，可以联系华为技术支持对用户数据做资源空间合并。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`
}

Request Object

func (DeleteProductRequest) String 

func (o DeleteProductRequest) String() string

type DeleteProductResponse 

type DeleteProductResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteProductResponse) String 

func (o DeleteProductResponse) String() string

type DeleteQueueRequest 

type DeleteQueueRequest struct {

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

	// **参数说明**：队列ID，用于唯一标识一个队列。 **取值范围**：长度36位，只允许字母、数字、下划线（_）、连接符（-）的组合。
	QueueId string `json:"queue_id"`
}

Request Object

func (DeleteQueueRequest) String 

func (o DeleteQueueRequest) String() string

type DeleteQueueResponse 

type DeleteQueueResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteQueueResponse) String 

func (o DeleteQueueResponse) String() string

type DeleteRoutingRuleRequest 

type DeleteRoutingRuleRequest struct {

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

	// **参数说明**：规则条件ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	RuleId string `json:"rule_id"`
}

Request Object

func (DeleteRoutingRuleRequest) String 

func (o DeleteRoutingRuleRequest) String() string

type DeleteRoutingRuleResponse 

type DeleteRoutingRuleResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteRoutingRuleResponse) String 

func (o DeleteRoutingRuleResponse) String() string

type DeleteRuleActionRequest 

type DeleteRuleActionRequest struct {

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

	// **参数说明**：规则动作ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ActionId string `json:"action_id"`
}

Request Object

func (DeleteRuleActionRequest) String 

func (o DeleteRuleActionRequest) String() string

type DeleteRuleActionResponse 

type DeleteRuleActionResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteRuleActionResponse) String 

func (o DeleteRuleActionResponse) String() string

type DeleteRuleRequest 

type DeleteRuleRequest struct {

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

	// **参数说明**：规则ID，用于唯一标识一条规则，在创建规则时由物联网平台分配获得。 **取值范围**：长度不超过32，只允许字母、数字的组合。
	RuleId string `json:"rule_id"`
}

Request Object

func (DeleteRuleRequest) String 

func (o DeleteRuleRequest) String() string

type DeleteRuleResponse 

type DeleteRuleResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (DeleteRuleResponse) String 

func (o DeleteRuleResponse) String() string

type DeviceBroadcastRequest added in v0.1.37 

type DeviceBroadcastRequest struct {

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定广播消息所属的资源空间，否则广播消息将会向[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下订阅指定topic的设备发送。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：接收广播消息的完整Topic名称, 必选。用户需要发布广播消息给设备时，可以使用该参数指定完整的topic名称，物联网平台会向指定资源空间下订阅了该topic的所有在线设备发送消息。广播的topic无需控制台创建，但topic的前缀必须为$oc/broadcast/
	TopicFullName string `json:"topic_full_name"`

	// **参数说明**：广播消息的内容，用户需要将消息原文使用Base64编码，Base64编码后的长度不超过128KB。
	Message string `json:"message"`

	// **参数说明**：广播消息在平台缓存的老化时间，时间单位是分钟，默认值为0；ttl参数数值必须是5的倍数，即以5分钟为粒度；指定为0时表示不缓存消息，最大缓存时间1440分钟，即缓存一天；ttl>0时，一个topic订阅设备数限制为10，如果一个topic订阅设备数超过10，则接口返回错误。
	Ttl *int32 `json:"ttl,omitempty"`

	// **参数说明**：消息id，由用户生成（推荐使用UUID）。ttl> 0时，平台会缓存消息，需确保message_id是唯一的， 否则接口返回错误。 **取值范围**：长度不超过100，只允许字母、数字、下划线（_）、连接符（-）的组合。
	MessageId *string `json:"message_id,omitempty"`
}

func (DeviceBroadcastRequest) String added in v0.1.37 

func (o DeviceBroadcastRequest) String() string

type DeviceCommandRequest 

type DeviceCommandRequest struct {

	// **参数说明**：设备命令所属的设备服务ID，在设备关联的产品模型中定义。 **取值范围**：长度不超过64的字符串。
	ServiceId *string `json:"service_id,omitempty"`

	// **参数说明**：设备命令名称，在设备关联的产品模型中定义。 **取值范围**：长度不超过128的字符串。
	CommandName *string `json:"command_name,omitempty"`

	// **参数说明**：设备执行的命令，Json格式，里面是一个个键值对，如果serviceId不为空，每个键都是profile中命令的参数名（paraName）;如果serviceId为空则由用户自定义命令格式。设备命令示例：{\"value\":\"1\"}，具体格式需要应用和设备约定。此参数仅支持Json格式，暂不支持字符串。
	Paras *interface{} `json:"paras"`
}

func (DeviceCommandRequest) String 

func (o DeviceCommandRequest) String() string

type DeviceDataCondition 

type DeviceDataCondition struct {

	// **参数说明**：设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。存在该参数时设备属性触发根据指定设备触发，该参数值和product_id不能同时为空。如果该参数和product_id同时存在时，以该参数值对应的设备进行条件过滤。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId *string `json:"device_id,omitempty"`

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。存在该参数且device_id为空时设备属性触发匹配该产品下所有设备触发，该参数值和device_id不能同时为空。
	ProductId *string `json:"product_id,omitempty"`

	// 数据过滤条件。
	Filters *[]PropertyFilter `json:"filters,omitempty"`
}

条件中设备数据类型的信息，自定义结构。

func (DeviceDataCondition) String 

func (o DeviceDataCondition) String() string

type DeviceGroupResponseSummary added in v0.1.34 

type DeviceGroupResponseSummary struct {

	// 设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。
	GroupId *string `json:"group_id,omitempty"`

	// 设备组名称，单个资源空间下不可重复。
	Name *string `json:"name,omitempty"`

	// 设备组描述。
	Description *string `json:"description,omitempty"`

	// 父设备组ID，该设备组的父设备组ID。
	SuperGroupId *string `json:"super_group_id,omitempty"`

	// **参数说明**：设备组类型，默认为静态设备组；当设备组类型为动态设备组时，需要填写动态设备组规则
	GroupType *string `json:"group_type,omitempty"`
}

设备组信息结构体，创建、查询、修改设备组时返回

func (DeviceGroupResponseSummary) String added in v0.1.34 

func (o DeviceGroupResponseSummary) String() string

type DeviceLinkageStatusCondition added in v0.1.34 

type DeviceLinkageStatusCondition struct {

	// **参数说明**：设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。存在该参数时设备状态触发根据指定设备触发，该参数值和product_id不能同时为空。如果该参数和product_id同时存在时，以该参数值对应的设备进行条件过滤。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId *string `json:"device_id,omitempty"`

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。存在该参数且device_id为空时设备状态触发匹配该产品下所有设备触发，该参数值和device_id不能同时为空。
	ProductId *string `json:"product_id,omitempty"`

	// **参数说明**：状态列表，设备状态条件携带该参数。 **取值范围**： - ONLINE：设备上线 - OFFLINE：设备下线
	StatusList *[]string `json:"status_list,omitempty"`

	// **持续时长**：设备状态持续时长，取值范围: 0-60(分钟)。
	Duration *int32 `json:"duration,omitempty"`
}

条件中设备状态类型的信息，自定义结构。

func (DeviceLinkageStatusCondition) String added in v0.1.34 

func (o DeviceLinkageStatusCondition) String() string

type DeviceMessage 

type DeviceMessage struct {

	// 设备消息ID，用于唯一标识一条消息，在下发设备消息时由物联网平台分配获得。
	MessageId *string `json:"message_id,omitempty"`

	// 消息名称,在下发消息时由用户指定。
	Name *string `json:"name,omitempty"`

	// 消息内容。
	Message *interface{} `json:"message,omitempty"`

	// 消息内容编码格式，取值范围none|base64,默认值none, base64格式仅支持透传。
	Encoding *string `json:"encoding,omitempty"`

	// 有效负载格式，在消息内容编码格式为none时有效，取值范围standard|raw，默认值standard（平台封装的标准格式），取值为raw时直接将消息内容作为有效负载下发。
	PayloadFormat *string `json:"payload_format,omitempty"`

	// 消息topic
	Topic *string `json:"topic,omitempty"`

	Properties *PropertiesDto `json:"properties,omitempty"`

	// 消息状态，包含PENDING，DELIVERED，FAILED和TIMEOUT，PENDING指设备不在线，消息被缓存起来，等设备上线之后下发； DELIVERED指消息发送成功；FAILED消息发送失败；TIMEOUT指消息在平台默认时间内（1天）还没有下发送给设备，则平台会将消息设置为超时，状态为TIMEOUT。
	Status *string `json:"status,omitempty"`

	ErrorInfo *ErrorInfoDto `json:"error_info,omitempty"`

	// 消息的创建时间，\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串。
	CreatedTime *string `json:"created_time,omitempty"`

	// 消息结束时间, \"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串，包含消息转换到DELIVERED和TIMEOUT两个状态的时间。
	FinishedTime *string `json:"finished_time,omitempty"`
}

func (DeviceMessage) String 

func (o DeviceMessage) String() string

type DeviceMessageRequest 

type DeviceMessageRequest struct {

	// **参数说明**：消息id，由用户生成（推荐使用UUID），同一个设备下唯一， 如果用户填写的id在设备下不唯一， 则接口返回错误。 **取值范围**：长度不超过100，只允许字母、数字、下划线（_）、连接符（-）的组合。
	MessageId *string `json:"message_id,omitempty"`

	// **参数说明**：消息名称。 **取值范围**：长度不超过128，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	Name *string `json:"name,omitempty"`

	// **参数说明**：消息内容，支持string和json格式。
	Message *interface{} `json:"message"`

	Properties *PropertiesDto `json:"properties,omitempty"`

	// **参数说明**：消息内容编码格式。默认值none。 **取值范围**： - none  - base64
	Encoding *string `json:"encoding,omitempty"`

	// **参数说明**：有效负载格式，在消息内容编码格式为none时有效。默认值standard（平台封装的标准格式）。 **取值范围**： - standard  - raw：直接将消息内容作为有效负载下发。
	PayloadFormat *string `json:"payload_format,omitempty"`

	// **参数说明**：消息下行到设备的自定义topic后缀, 可选， 仅适用于MQTT协议接入的设备。 用户只能填写在租户产品界面配置的topic, 否则会校验不通过。 平台给消息topic添加的前缀为$oc/devices/{device_id}/user/， 用户可以在前缀的基础上增加自定义部分， 如增加messageDown，则平台拼接前缀后完整的topic为 $oc/devices/{device_id}/user/messageDown，其中device_id以实际设备的网关id替代。 如果用户指定该topic，消息会通过该topic下行到设备，如果用户不指定， 则消息通过系统默认的topic下行到设备,系统默认的topic格式为： $oc/devices/{device_id}/sys/messages/down。此字段与topic_full_name字段只可填写一个。
	Topic *string `json:"topic,omitempty"`

	// **参数说明**：消息下行到设备的完整topic名称, 可选。用户需要下发用户自定义的topic给设备时，可以使用该参数指定完整的topic名称，物联网平台不校验该topic是否在平台定义，直接透传给设备。设备需要提前订阅该topic。此字段与topic字段只可填写一个。
	TopicFullName *string `json:"topic_full_name,omitempty"`

	// **参数说明**：下发消息在平台缓存的老化时间，时间单位是分钟，默认值1440；ttl参数数值必须是5的倍数，即以5分钟为粒度；指定为0时表示不缓存消息，最大缓存时间1440分钟，即缓存一天
	Ttl *int32 `json:"ttl,omitempty"`
}

func (DeviceMessageRequest) String 

func (o DeviceMessageRequest) String() string

type DevicePropertiesRequest 

type DevicePropertiesRequest struct {

	// **参数说明**：设备执行的属性，Json格式，里面是一个个健值对，如果serviceId不为空，每个健都是profile中属性的参数名（paraName）;如果serviceId为空则由用户自定义属性格式。设属性令示例：[{\"service_id\": \"Temperature\",\"properties\": {\"value\": 57}},{\"service_id\": \"Battery\",\"properties\": {\"level\": 80}}]，具体格式需要应用和设备约定。
	Services *interface{} `json:"services,omitempty"`
}

func (DevicePropertiesRequest) String 

func (o DevicePropertiesRequest) String() string

type DeviceShadowData 

type DeviceShadowData struct {

	// 设备的服务ID，在设备关联的产品模型中定义。
	ServiceId string `json:"service_id"`

	Desired *DeviceShadowProperties `json:"desired,omitempty"`

	Reported *DeviceShadowProperties `json:"reported,omitempty"`

	// 设备影子的版本，携带该参数时平台会校验值必须等于当前影子版本，初始从0开始。
	Version *int64 `json:"version,omitempty"`
}

设备影子数据结构体。

func (DeviceShadowData) String 

func (o DeviceShadowData) String() string

type DeviceShadowProperties 

type DeviceShadowProperties struct {

	// 设备影子的属性数据，Json格式，里面是一个个键值对，每个键都是产品模型中属性的参数名(property_name)，目前如样例所示只支持一层结构。 **注意**：JSON结构的key当前不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00),key为以上特殊字符无法正常刷新设备影子
	Properties *interface{} `json:"properties,omitempty"`

	// 事件操作时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	EventTime *string `json:"event_time,omitempty"`
}

设备影子数据属性结构体。

func (DeviceShadowProperties) String 

func (o DeviceShadowProperties) String() string

type DeviceSide added in v0.1.18 

type DeviceSide struct {

	// **参数说明**：端侧执行下发的目标设备ID列表。设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。
	DeviceIds *[]string `json:"device_ids,omitempty"`
}

端侧设备信息

func (DeviceSide) String added in v0.1.18 

func (o DeviceSide) String() string

type DisForwarding 

type DisForwarding struct {

	// **参数说明**：DIS服务对应的region区域
	RegionName string `json:"region_name"`

	// **参数说明**：DIS服务对应的projectId信息
	ProjectId string `json:"project_id"`

	// **参数说明**：DIS服务对应的通道名称，stream_id和stream_name两个参数必须携带一个，优先使用stream_id
	StreamName *string `json:"stream_name,omitempty"`

	// **参数说明**：DIS服务对应的通道ID，stream_id和stream_name两个参数必须携带一个，优先使用stream_id
	StreamId *string `json:"stream_id,omitempty"`
}

DIS服务配置信息

func (DisForwarding) String 

func (o DisForwarding) String() string

type DmsKafkaForwarding 

type DmsKafkaForwarding struct {

	// **参数说明**：Kafka服务对应的region区域
	RegionName string `json:"region_name"`

	// **参数说明**：Kafka服务对应的projectId信息
	ProjectId string `json:"project_id"`

	// **参数说明**：转发kafka消息对应的地址列表
	Addresses []NetAddress `json:"addresses"`

	// **参数说明**：转发kafka消息关联的topic信息。
	Topic string `json:"topic"`

	// **参数说明**：转发kafka关联的用户名信息。
	Username *string `json:"username,omitempty"`

	// **参数说明**：转发kafka关联的密码信息。
	Password *string `json:"password,omitempty"`

	// **参数说明**：转发kafka关联的鉴权机制。 **取值范围**： - PAAS：非SASL鉴权。 - PLAIN：SASL/PLAIN模式。需要填写对应的用户名密码信息。
	Mechanism *string `json:"mechanism,omitempty"`
}

转发kafka消息结构

func (DmsKafkaForwarding) String 

func (o DmsKafkaForwarding) String() string

type DmsRocketMqForwarding added in v0.1.25 

type DmsRocketMqForwarding struct {

	// **参数说明**：转发rocketMQ消息对应的地址列表
	Addresses []NetAddress `json:"addresses"`

	// **参数说明**：转发rocketMQ消息关联的topic信息。
	Topic string `json:"topic"`

	// **参数说明**：转发rocketMQ关联的用户名信息。
	Username string `json:"username"`

	// **参数说明**：转发rocketMQ关联的密码信息。
	Password string `json:"password"`

	// 是否开启SSL，默认为true。
	EnableSsl *bool `json:"enable_ssl,omitempty"`
}

rocketMQ服务配置信息

func (DmsRocketMqForwarding) String added in v0.1.25 

func (o DmsRocketMqForwarding) String() string

type ErrorInfo 

type ErrorInfo struct {

	// 错误码
	ErrorCode *string `json:"error_code,omitempty"`

	// 错误描述
	ErrorMsg *string `json:"error_msg,omitempty"`
}

错误码消息

func (ErrorInfo) String 

func (o ErrorInfo) String() string

type ErrorInfoDto added in v0.1.3 

type ErrorInfoDto struct {

	// **参数说明**：异常信息错误码，包含IOTDA.014016和IOTDA.014112。IOTDA.014016表示设备不在线；IOTDA.014112表示设备没有订阅topic。
	ErrorCode *string `json:"error_code,omitempty"`

	// **参数说明**：异常信息说明，包含设备不在线和设备没有订阅topic说明。
	ErrorMsg *string `json:"error_msg,omitempty"`
}

异常信息

func (ErrorInfoDto) String added in v0.1.3 

func (o ErrorInfoDto) String() string

type FileLocation added in v0.1.28 

type FileLocation struct {
	ObsLocation *ObsLocation `json:"obs_location,omitempty"`
}

升级包的位置

func (FileLocation) String added in v0.1.28 

func (o FileLocation) String() string

type FreezeDeviceRequest 

type FreezeDeviceRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`
}

Request Object

func (FreezeDeviceRequest) String 

func (o FreezeDeviceRequest) String() string

type FreezeDeviceResponse 

type FreezeDeviceResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (FreezeDeviceResponse) String 

func (o FreezeDeviceResponse) String() string

type FunctionGraphForwarding 

type FunctionGraphForwarding struct {

	// **参数说明**：函数的URN（Uniform Resource Name），唯一标识函数。
	FuncUrn string `json:"func_urn"`

	// **参数说明**：函数名称。
	FuncName string `json:"func_name"`
}

函数工作流转发配置信息

func (FunctionGraphForwarding) String 

func (o FunctionGraphForwarding) String() string

type HttpForwarding 

type HttpForwarding struct {

	// **参数说明**：用于接收满足规则条件数据的http服务器地址。
	Url string `json:"url"`

	// **参数说明**：证书id，请参见[[加载推送证书第3步](https://support.huaweicloud.com/usermanual-iothub/iot_01_0001.html#section3)](tag:hws)[[加载推送证书第3步](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0001.html#section3)](tag:hws_hk)获取证书ID
	CertId *string `json:"cert_id,omitempty"`

	// **参数说明**：当sni_enable为true时，此字段需要填写，内容为将要请求的服务端证书的域名,举例:domain:8443;当sni_enbale为false时，此字段默认不填写。
	CnName *string `json:"cn_name,omitempty"`

	// **参数说明**：需要https服务端和客户端都支持此功能，默认为false，设成true表明Https的客户端在发起请求时，需要携带cn_name；https服务端根据cn_name返回对应的证书；设为false可关闭此功能。
	SniEnable *bool `json:"sni_enable,omitempty"`

	// **参数说明**：是否启用签名。填写token时， 该参数必须为true， token才可以生效，否则token不生效。推荐设置成true，使用token签名验证消息是否来自平台。
	SignatureEnable *bool `json:"signature_enable,omitempty"`

	// **参数说明**：用作生成签名的Token，客户端可以使用该token按照规则生成签名并与推送消息中携带的签名做对比， 从而验证安全性。**取值范围**: 长度不超过32， 不小于3， 只允许字母、数字的组合。请参见[[HTTP/HTTPS推送基于Token认证物联网平台](https://support.huaweicloud.com/usermanual-iothub/iot_01_0001.html#section6)](tag:hws)[[HTTP/HTTPS推送基于Token认证物联网平台](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0001.html#section6)](tag:hws_hk)
	Token *string `json:"token,omitempty"`
}

httpserver配置信息

func (HttpForwarding) String 

func (o HttpForwarding) String() string

type InfluxDbForwarding 

type InfluxDbForwarding struct {
	Address *NetAddress `json:"address"`

	// **参数说明**：连接InfluxDB数据库的库名,不存在会自动创建
	DbName string `json:"db_name"`

	// **参数说明**：连接InfluxDB数据库的用户名
	Username string `json:"username"`

	// **参数说明**：连接InfluxDB数据库的密码
	Password string `json:"password"`

	// **参数说明**：InfluxDB数据库的measurement,不存在会自动创建
	Measurement string `json:"measurement"`

	// **参数说明**：InfluxDB数据库和流转数据的对应关系列表。
	ColumnMappings []ColumnMapping `json:"column_mappings"`
}

InfluxDB配置信息

func (InfluxDbForwarding) String 

func (o InfluxDbForwarding) String() string

type InitialDesired 

type InitialDesired struct {

	// **参数说明**：设备的服务ID，在设备关联的产品模型中定义。 **取值范围**：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	ServiceId string `json:"service_id"`

	// **参数说明**：设备初始配置属性数据，Json格式，里面是一个个键值对，每个键都是产品模型中属性的参数名(property_name)，目前如样例所示只支持一层结构；这里设置的属性值与产品中对应属性的默认值比对，如果不同，则将以该字段中设置的属性值为准写入到设备影子中；如果想要删除整个desired可以填写空object(例如\"desired\":{})，如果想要删除某一个属性期望值可以将属性置位null(例如{\"temperature\":null})
	Desired *interface{} `json:"desired"`
}

设备初始配置数据结构体。

func (InitialDesired) String 

func (o InitialDesired) String() string

type ListBatchTaskFilesRequest 

type ListBatchTaskFilesRequest struct {

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

Request Object

func (ListBatchTaskFilesRequest) String 

func (o ListBatchTaskFilesRequest) String() string

type ListBatchTaskFilesResponse 

type ListBatchTaskFilesResponse struct {

	// 批量任务文件列表。
	Files          *[]BatchTaskFile `json:"files,omitempty"`
	HttpStatusCode int              `json:"-"`
}

Response Object

func (ListBatchTaskFilesResponse) String 

func (o ListBatchTaskFilesResponse) String() string

type ListBatchTasksRequest 

type ListBatchTasksRequest struct {

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

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的任务列表，不携带该参数则会查询该用户下所有任务列表。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：批量任务类型。 **取值范围**： - softwareUpgrade: 软件升级任务 - firmwareUpgrade: 固件升级任务 - createDevices: 批量创建设备任务 - deleteDevices: 批量删除设备任务 - freezeDevices: 批量冻结设备任务 - unfreezeDevices: 批量解冻设备任务 - createCommands: 批量创建同步命令任务 - createAsyncCommands: 批量创建异步命令任务 - createMessages: 批量创建消息任务 - updateDeviceShadows：批量配置设备影子任务 - updateDevices：批量更新设备任务
	TaskType string `json:"task_type"`

	// **参数说明**：批量任务的状态，可选参数。 **取值范围**： - Initializing: 初始化中。 - Waitting: 等待中。 - Processing: 执行中。 - Success: 成功。 - Fail: 失败。 - PartialSuccess: 部分成功。 - Stopped: 停止。 - Stopping: 停止中。
	Status *string `json:"status,omitempty"`

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从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。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ListBatchTasksRequest) String 

func (o ListBatchTasksRequest) String() string

type ListBatchTasksResponse 

type ListBatchTasksResponse struct {

	// 批量任务列表。
	Batchtasks *[]Task `json:"batchtasks,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ListBatchTasksResponse) String 

func (o ListBatchTasksResponse) String() string

type ListCertificatesRequest 

type ListCertificatesRequest struct {

	// Sp用户Token。通过调用IoBPS服务获取SP用户Token
	SpAuthToken *string `json:"Sp-Auth-Token,omitempty"`

	// Stage用户的Token, 仅提供给IoStage服务使用
	StageAuthToken *string `json:"Stage-Auth-Token,omitempty"`

	// 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	// 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的证书列表，不携带该参数则会查询该用户下所有证书列表。
	AppId *string `json:"app_id,omitempty"`

	// 分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。
	Limit *int32 `json:"limit,omitempty"`

	// 上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。
	Marker *string `json:"marker,omitempty"`

	// 表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ListCertificatesRequest) String 

func (o ListCertificatesRequest) String() string

type ListCertificatesResponse 

type ListCertificatesResponse struct {

	// 证书列表。
	Certificates *[]CertificatesRspDto `json:"certificates,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ListCertificatesResponse) String 

func (o ListCertificatesResponse) String() string

type ListDeviceGroupsRequest 

type ListDeviceGroupsRequest struct {

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

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 **取值范围**：0-500的整数，默认为0。
	Offset *int32 `json:"offset,omitempty"`

	// **参数说明**：查询设备组在last_modified_time之后修改的记录。 **取值范围**：格式为yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	LastModifiedTime *string `json:"last_modified_time,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的产品列表，不携带该参数则会查询该用户下所有产品列表。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：设备组类型，默认为静态设备组；当设备组类型为动态设备组时，需要填写动态设备组规则
	GroupType *string `json:"group_type,omitempty"`

	// **参数说明**：设备组名称，单个资源空间下不可重复。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。
	Name *string `json:"name,omitempty"`
}

Request Object

func (ListDeviceGroupsRequest) String 

func (o ListDeviceGroupsRequest) String() string

type ListDeviceGroupsResponse 

type ListDeviceGroupsResponse struct {

	// 设备组信息列表。
	DeviceGroups *[]DeviceGroupResponseSummary `json:"device_groups,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ListDeviceGroupsResponse) String 

func (o ListDeviceGroupsResponse) String() string

type ListDeviceMessagesRequest 

type ListDeviceMessagesRequest struct {

	// **参数说明**：下发消息的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

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

Request Object

func (ListDeviceMessagesRequest) String 

func (o ListDeviceMessagesRequest) String() string

type ListDeviceMessagesResponse 

type ListDeviceMessagesResponse struct {

	// 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备消息列表。
	Messages       *[]DeviceMessage `json:"messages,omitempty"`
	HttpStatusCode int              `json:"-"`
}

Response Object

func (ListDeviceMessagesResponse) String 

func (o ListDeviceMessagesResponse) String() string

type ListDevicesRequest 

type ListDevicesRequest struct {

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

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId *string `json:"product_id,omitempty"`

	// **参数说明**：网关ID，用于标识设备所属的父设备，即父设备的设备ID。携带该参数时，表示查询该设备下的子设备，默认查询下一级子设备，如果需要查询该设备下所有各级子设备，请同时携带is_cascade_query参数为true；不携带该参数时，表示查询用户下所有设备。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	GatewayId *string `json:"gateway_id,omitempty"`

	// **参数说明**：是否级联查询，该参数仅在同时携带gateway_id时生效。默认值为false。 **取值范围**： - true：表示查询设备ID等于gateway_id参数的设备下的所有各级子设备。 - false：表示查询设备ID等于gateway_id参数的设备下的一级子设备。
	IsCascadeQuery *bool `json:"is_cascade_query,omitempty"`

	// **参数说明**：设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。 **取值范围**：长度不超过64，只允许字母、数字、下划线（_）、连接符（-）的组合。
	NodeId *string `json:"node_id,omitempty"`

	// **参数说明**：设备名称。 **取值范围**：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	DeviceName *string `json:"device_name,omitempty"`

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从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。
	Offset *int32 `json:"offset,omitempty"`

	// **参数说明**：查询设备注册时间在startTime之后的记录，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	StartTime *string `json:"start_time,omitempty"`

	// **参数说明**：查询设备注册时间在endTime之前的记录，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	EndTime *string `json:"end_time,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的设备列表，不携带该参数则会查询该用户下所有设备列表。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`
}

Request Object

func (ListDevicesRequest) String 

func (o ListDevicesRequest) String() string

type ListDevicesResponse 

type ListDevicesResponse struct {

	// 设备信息列表。
	Devices *[]QueryDeviceSimplify `json:"devices,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ListDevicesResponse) String 

func (o ListDevicesResponse) String() string

type ListOtaPackageInfoRequest added in v0.1.28 

type ListOtaPackageInfoRequest struct {

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

	// **参数说明**：资源空间ID。存在多资源空间的用户需要使用该接口时，建议携带该参数指定查询指定资源空间的升级包列表。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：升级包类型。 **取值范围**：软件包必须设置为：softwarePackage，固件包必须设置为：firmwarePackage。
	PackageType string `json:"package_type"`

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId *string `json:"product_id,omitempty"`

	// **参数说明**：升级包版本号。 **取值范围**：长度不超过256，只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	Version *string `json:"version,omitempty"`

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。**取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从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。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ListOtaPackageInfoRequest) String added in v0.1.28 

func (o ListOtaPackageInfoRequest) String() string

type ListOtaPackageInfoResponse added in v0.1.28 

type ListOtaPackageInfoResponse struct {

	// 升级包列表
	Packages *[]OtaPackageInfo `json:"packages,omitempty"`

	Page           *PageInfo `json:"page,omitempty"`
	HttpStatusCode int       `json:"-"`
}

Response Object

func (ListOtaPackageInfoResponse) String added in v0.1.28 

func (o ListOtaPackageInfoResponse) String() string

type ListProductsRequest 

type ListProductsRequest struct {

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

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的产品列表，不携带该参数则会查询该用户下所有产品列表。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 **取值范围**：0-500的整数，默认为0。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ListProductsRequest) String 

func (o ListProductsRequest) String() string

type ListProductsResponse 

type ListProductsResponse struct {

	// 产品信息列表。
	Products *[]ProductSummary `json:"products,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ListProductsResponse) String 

func (o ListProductsResponse) String() string

type ListPropertiesRequest 

type ListPropertiesRequest struct {

	// **参数说明**：下发属性的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

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

	// **参数说明**：设备的服务ID，在设备关联的产品模型中定义。
	ServiceId string `json:"service_id"`
}

Request Object

func (ListPropertiesRequest) String 

func (o ListPropertiesRequest) String() string

type ListPropertiesResponse 

type ListPropertiesResponse struct {

	// 设备上报的属性执行结果。Json格式，具体格式需要应用和设备约定。
	Response       *interface{} `json:"response,omitempty"`
	HttpStatusCode int          `json:"-"`
}

Response Object

func (ListPropertiesResponse) String 

func (o ListPropertiesResponse) String() string

type ListResourcesByTagsRequest 

type ListResourcesByTagsRequest struct {

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

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 **取值范围**：0-500的整数，默认为0。
	Offset *int32 `json:"offset,omitempty"`

	Body *QueryResourceByTagsDto `json:"body,omitempty"`
}

Request Object

func (ListResourcesByTagsRequest) String 

func (o ListResourcesByTagsRequest) String() string

type ListResourcesByTagsResponse 

type ListResourcesByTagsResponse struct {

	// 资源列表。
	Resources *[]ResourceDto `json:"resources,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ListResourcesByTagsResponse) String 

func (o ListResourcesByTagsResponse) String() string

type ListRoutingRulesRequest 

type ListRoutingRulesRequest struct {

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

	// **参数说明**：订阅的资源名称。 **取值范围**： - device：设备。 - device.property：设备属性。 - device.message：设备消息。 - device.message.status：设备消息状态。 - device.status：设备状态。 - batchtask：批量任务。 - product：产品。 - device.command.status：设备异步命令状态。
	Resource *string `json:"resource,omitempty"`

	// **参数说明**：订阅的资源事件。 **取值范围**：与资源有关，不同的资源，事件不同。 event需要与resource关联使用，具体的“resource：event”映射关系如下： - device：create（设备添加） - device：delete（设备删除） - device：update（设备更新） - device.status：update （设备状态变更） - device.property：report（设备属性上报） - device.message：report（设备消息上报） - device.message.status：update（设备消息状态变更） - batchtask：update （批量任务状态变更） - product：create（产品添加） - product：delete（产品删除） - product：update（产品更新） - device.command.status：update（设备异步命令状态更新）。
	Event *string `json:"event,omitempty"`

	// **参数说明**：租户规则的生效范围。 **取值范围**： - GLOBAL：生效范围为租户级。 - APP：生效范围为资源空间级。如果类型为APP，可携带app_id查询指定资源空间下的规则动作列表，不携带app_id则查询[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下的规则列表。
	AppType *string `json:"app_type,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，携带app_id查询指定资源空间下的规则动作列表，不携带app_id则查询[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下的规则动作列表。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：用户自定义的规则名称
	RuleName *string `json:"rule_name,omitempty"`

	// **参数说明**：规则条件的状态是否为激活。
	Active *bool `json:"active,omitempty"`

	// **参数说明**：分页查询时每页显示的记录数。默认每页10条记录，最大设定每页50条记录。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从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。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ListRoutingRulesRequest) String 

func (o ListRoutingRulesRequest) String() string

type ListRoutingRulesResponse 

type ListRoutingRulesResponse struct {

	// 规则条件信息列表。
	Rules *[]RoutingRule `json:"rules,omitempty"`

	// 满足查询条件的记录总数。
	Count *int32 `json:"count,omitempty"`

	// 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。
	Marker         *string `json:"marker,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ListRoutingRulesResponse) String 

func (o ListRoutingRulesResponse) String() string

type ListRuleActionsRequest 

type ListRuleActionsRequest struct {

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

	// **参数说明**：规则触发条件ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	RuleId *string `json:"rule_id,omitempty"`

	// **参数说明**：规则动作的类型。 **取值范围**： - HTTP_FORWARDING：HTTP服务消息类型。 - DIS_FORWARDING：转发DIS服务消息类型。 - OBS_FORWARDING：转发OBS服务消息类型。 - AMQP_FORWARDING：转发AMQP服务消息类型。 - DMS_KAFKA_FORWARDING：转发kafka消息类型。[ - ROMA_FORWARDING：转发Roma消息类型。（仅企业版支持） - INFLUXDB_FORWARDING：转发InfluxDB消息类型。（仅标准版和企业版支持） - MYSQL_FORWARDING：转发MySQL消息类型。（仅标准版和企业版支持） - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。（仅标准版和企业版支持） - MRS_KAFKA_FORWARDING：转发MRS_KAFKA消息类型。（仅企业版支持） - DMS_ROCKETMQ_FORWARDING：转发RocketMQ消息类型。（仅标准版和企业版支持）](tag:hws)[ - INFLUXDB_FORWARDING：转发InfluxDB消息类型。 - MYSQL_FORWARDING：转发MySQL消息类型。 - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。](tag:hws_hk)
	Channel *string `json:"channel,omitempty"`

	// **参数说明**：租户规则的生效范围。 **取值范围**： - GLOBAL：生效范围为租户级。 - APP：生效范围为资源空间级。如果类型为APP，可携带app_id查询指定资源空间下的规则动作列表，不携带app_id则查询[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下的规则动作列表。
	AppType *string `json:"app_type,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，rule_id不携带且app_type为APP时，该参数生效，可携带app_id查询指定资源空间下的规则动作列表，不携带app_id则查询[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下的规则动作列表。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：分页查询时每页显示的记录数。默认每页10条记录，最大设定每页50条记录。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从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。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ListRuleActionsRequest) String 

func (o ListRuleActionsRequest) String() string

type ListRuleActionsResponse 

type ListRuleActionsResponse struct {

	// 规则动作信息列表。
	Actions *[]RoutingRuleAction `json:"actions,omitempty"`

	// 满足查询条件的记录总数。
	Count *int32 `json:"count,omitempty"`

	// 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。
	Marker         *string `json:"marker,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ListRuleActionsResponse) String 

func (o ListRuleActionsResponse) String() string

type ListRulesRequest 

type ListRulesRequest struct {

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

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的规则列表，不携带该参数则会查询该用户下所有规则列表。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：规则类型。此参数为非必选参数，指定对应的规则类型结果进行返回，不携带该参数则会返回所有类型规则。 **取值范围**： - DEVICE_LINKAGE：云端联动规则。  - DEVICE_SIDE：端侧规则。
	RuleType *string `json:"rule_type,omitempty"`

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从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。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ListRulesRequest) String 

func (o ListRulesRequest) String() string

type ListRulesResponse 

type ListRulesResponse struct {

	// 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。
	Marker *string `json:"marker,omitempty"`

	// 满足查询条件的记录总数。
	Count *int64 `json:"count,omitempty"`

	// 规则信息列表。
	Rules          *[]RuleResponse `json:"rules,omitempty"`
	HttpStatusCode int             `json:"-"`
}

Response Object

func (ListRulesResponse) String 

func (o ListRulesResponse) String() string

type MessageResult 

type MessageResult struct {

	// 消息状态, PENDING，DELIVERED，FAILED和TIMEOUT。如果设备不在线，则平台缓存消息，并且返回PENDING，等设备数据上报之后再下发；如果设备在线，则消息直接进行下发，下发成功后接口返回DELIVERED，失败返回FAILED；如果消息在平台默认时间内（1天）还没有下发给设备，则平台会将消息设置为超时，状态为TIMEOUT。另外应用可以订阅消息的执行结果，平台会将消息结果推送给订阅的应用。
	Status *string `json:"status,omitempty"`

	// 消息的创建时间，\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串。
	CreatedTime *string `json:"created_time,omitempty"`

	// 消息结束时间, \"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串，包含消息转换到DELIVERED，FAILED和TIMEOUT状态的时间。
	FinishedTime *string `json:"finished_time,omitempty"`
}

下发的消息响应结果

func (MessageResult) String 

func (o MessageResult) String() string

type MrsKafkaForwarding 

type MrsKafkaForwarding struct {

	// **参数说明**：转发kafka消息对应的地址列表
	Addresses []NetAddress `json:"addresses"`

	// **参数说明**：转发kafka消息关联的topic信息。
	Topic string `json:"topic"`

	// 是否Kerberos认证，默认为false。
	KerberosAuthentication *bool `json:"kerberos_authentication,omitempty"`
}

转发MRS Kafka消息结构

func (MrsKafkaForwarding) String 

func (o MrsKafkaForwarding) String() string

type MysqlForwarding 

type MysqlForwarding struct {
	Address *NetAddress `json:"address"`

	// **参数说明**：连接MYSQL数据库的库名。 **取值范围**：长度不超过64，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DbName string `json:"db_name"`

	// **参数说明**：连接MYSQL数据库的用户名
	Username string `json:"username"`

	// **参数说明**：连接MYSQL数据库的密码
	Password string `json:"password"`

	// **参数说明**：客户端是否使用SSL连接服务端，默认为true
	EnableSsl *bool `json:"enable_ssl,omitempty"`

	// **参数说明**：MYSQL数据库的表名
	TableName string `json:"table_name"`

	// **参数说明**：MYSQL数据库的列和流转数据的对应关系列表。
	ColumnMappings []ColumnMapping `json:"column_mappings"`
}

MySql配置信息

func (MysqlForwarding) String 

func (o MysqlForwarding) String() string

type NetAddress 

type NetAddress struct {

	// **参数说明**：服务的对应IP
	Ip *string `json:"ip,omitempty"`

	// **参数说明**：服务对应端口
	Port *int32 `json:"port,omitempty"`

	// **参数说明**：服务对应的域名
	Domain *string `json:"domain,omitempty"`
}

网络地址信息。

func (NetAddress) String 

func (o NetAddress) String() string

type ObsForwarding 

type ObsForwarding struct {

	// **参数说明**：OBS服务对应的region区域
	RegionName string `json:"region_name"`

	// **参数说明**：OBS服务对应的projectId信息
	ProjectId string `json:"project_id"`

	// **参数说明**：OBS服务对应的桶名称
	BucketName string `json:"bucket_name"`

	// **参数说明**：OBS服务对应桶的区域
	Location *string `json:"location,omitempty"`

	// **参数说明**：OBS服务中存储通道文件的自定义目录,多级目录可用(/)进行分隔，不可以斜杠(/)开头或结尾，不能包含两个以上相邻的斜杠(/) **取值范围**: 英文字母(a-zA-Z)、数字(0-9)、下划线(_)、中划线(-)、斜杠(/)和大括号({})，最大字符长度256个字符。其中大括号只能用于对应模板参数。 **模板参数**:    - \\{YYYY\\} 年   - \\{MM\\} 月   - \\{DD\\} 日   - \\{HH\\} 小时   - \\{appId\\} 应用ID   - \\{deviceId\\} 设备ID   例如:自定义目录结构为\\{YYYY\\}/\\{MM\\}/\\{DD\\}/\\{HH\\},则会在转发数据时，根据当前时间往对应的目录结构2021>08>11>09下生成对应的数据。
	FilePath *string `json:"file_path,omitempty"`
}

服务配置信息

func (ObsForwarding) String 

func (o ObsForwarding) String() string

type ObsLocation added in v0.1.28 

type ObsLocation struct {

	// **参数说明**：OBS所在区域。您可以从[[地区和终端节点](https://developer.huaweicloud.com/endpoint?OBS)](tag:hws)[[地区和终端节点](https://developer.huaweicloud.com/intl/zh-cn/endpoint?OBS)](tag:hws_hk)中查询服务的终端节点。 **取值范围**：长度不超过256，只允许字母、数字、连接符（-）的组合。
	RegionName string `json:"region_name"`

	// **参数说明**：OBS桶名称。 **取值范围**：长度最小为3，最大为63，只允许小写字母、数字、连接符（-）、英文点（.）的组合。
	BucketName string `json:"bucket_name"`

	// **参数说明**：OBS对象名称(包含文件夹路径)。 **取值范围**：长度不超过1024。
	ObjectKey string `json:"object_key"`
}

升级包在OBS的位置

func (ObsLocation) String added in v0.1.28 

func (o ObsLocation) String() string

type OtaPackageInfo added in v0.1.28 

type OtaPackageInfo struct {

	// **参数说明**：升级包ID，用于唯一标识一个升级包。由物联网平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、连接符（-）的组合。
	PackageId *string `json:"package_id,omitempty"`

	// **参数说明**：资源空间ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：升级包类型。 **取值范围**：软件包必须设置为：softwarePackage，固件包必须设置为：firmwarePackage。
	PackageType *string `json:"package_type,omitempty"`

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId *string `json:"product_id,omitempty"`

	// **参数说明**：升级包版本号。 **取值范围**：长度不超过256，只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	Version *string `json:"version,omitempty"`

	// **参数说明**：支持用于升级此版本包的设备源版本号列表。最多支持20个源版本号。 **取值范围**：源版本号列表，源版本号只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	SupportSourceVersions *[]string `json:"support_source_versions,omitempty"`

	// **参数说明**：用于描述升级包的功能等信息。 **取值范围**：长度不超过1024。
	Description *string `json:"description,omitempty"`

	// **参数说明**：推送给设备的自定义信息。添加该升级包完成，并创建升级任务后，物联网平台向设备下发升级通知时，会下发该自定义信息给设备。 **取值范围**：长度不超过4096。
	CustomInfo *string `json:"custom_info,omitempty"`

	// 软固件包上传到物联网平台的时间，格式：\"yyyyMMdd'T'HHmmss'Z'\"。
	CreateTime *string `json:"create_time,omitempty"`
}

设备升级包信息

func (OtaPackageInfo) String added in v0.1.28 

func (o OtaPackageInfo) String() string

type Page 

type Page struct {

	// 满足查询条件的记录总数。
	Count *int64 `json:"count,omitempty"`

	// 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。
	Marker *string `json:"marker,omitempty"`
}

查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大Id。

func (Page) String 

func (o Page) String() string

type PageInfo added in v0.1.28 

type PageInfo struct {

	// 满足查询条件的记录总数。
	Count *int64 `json:"count,omitempty"`

	// 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。
	Marker *string `json:"marker,omitempty"`
}

查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大Id。

func (PageInfo) String added in v0.1.28 

func (o PageInfo) String() string

type ProductSummary 

type ProductSummary struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。
	ProductId *string `json:"product_id,omitempty"`

	// 产品名称。
	Name *string `json:"name,omitempty"`

	// 设备类型。
	DeviceType *string `json:"device_type,omitempty"`

	// 设备使用的协议类型。取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF， OPC-UA，OPC-DA，Other。
	ProtocolType *string `json:"protocol_type,omitempty"`

	// 设备上报数据的格式，取值范围：json，binary。
	DataFormat *string `json:"data_format,omitempty"`

	// 厂商名称。
	ManufacturerName *string `json:"manufacturer_name,omitempty"`

	// 设备所属行业。
	Industry *string `json:"industry,omitempty"`

	// 产品的描述信息。
	Description *string `json:"description,omitempty"`

	// 在物联网平台创建产品的时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`
}

产品概要信息。

func (ProductSummary) String 

func (o ProductSummary) String() string

type PropertiesDto added in v0.1.6 

type PropertiesDto struct {

	// **参数说明**：MQTT 5.0版本请求和响应模式中的相关数据，可选。用户可以通过该参数配置MQTT协议请求和响应模式中的相关数据。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	CorrelationData *string `json:"correlation_data,omitempty"`

	// **参数说明**：MQTT 5.0版本请求和响应模式中的响应主题，可选。用户可以通过该参数配置MQTT协议请求和响应模式中的响应主题。 **取值范围**：长度不超过128, 只允许字母、数字、以及_-?=$#+/等字符的组合。
	ResponseTopic *string `json:"response_topic,omitempty"`

	// **参数说明**：用户自定义属性，可选。用户可以通过该参数配置用户自定义属性。可以配置的最大自定义属性数量为20。
	UserProperties *[]UserPropDto `json:"user_properties,omitempty"`
}

属性数据

func (PropertiesDto) String added in v0.1.6 

func (o PropertiesDto) String() string

type PropertyFilter 

type PropertyFilter struct {

	// **参数说明**：设备属性的路径信息，格式：service_id/DataProperty，例如门磁状态为“DoorWindow/status”。
	Path string `json:"path"`

	// **参数说明**：数据比较的操作符。 **取值范围**：当前支持的操作符有：>，<，>=，<=，=，in:表示在指定值中匹配和between:表示数值区间。
	Operator string `json:"operator"`

	// **参数说明**：数据比较表达式的右值。与数据比较操作符between联用时，右值表示最小值和最大值，用逗号隔开，如“20,30”表示大于等于20小于30。
	Value *string `json:"value,omitempty"`

	// **参数说明**：当operator为in时该字段必填，使用该字段传递比较表达式右值，上限为20个。
	InValues *[]string `json:"in_values,omitempty"`

	Strategy *Strategy `json:"strategy,omitempty"`
}

设备属性过滤信息，自定义结构。

func (PropertyFilter) String 

func (o PropertyFilter) String() string

type QueryDeviceSimplify 

type QueryDeviceSimplify struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。
	NodeId *string `json:"node_id,omitempty"`

	// 网关ID，用于标识设备所属的父设备，即父设备的设备ID。当设备是直连设备时，gateway_id与设备的device_id一致。当设备是非直连设备时，gateway_id为设备所关联的父设备的device_id。
	GatewayId *string `json:"gateway_id,omitempty"`

	// 设备名称。
	DeviceName *string `json:"device_name,omitempty"`

	// 设备节点类型。 - ENDPOINT：非直连设备。 - GATEWAY：直连设备或网关。 - UNKNOWN：未知。
	NodeType *string `json:"node_type,omitempty"`

	// 设备的描述信息。
	Description *string `json:"description,omitempty"`

	// 设备的固件版本。
	FwVersion *string `json:"fw_version,omitempty"`

	// 设备的软件版本。
	SwVersion *string `json:"sw_version,omitempty"`

	// 设备的sdk信息。
	DeviceSdkVersion *string `json:"device_sdk_version,omitempty"`

	// 设备关联的产品ID，用于唯一标识一个产品模型。
	ProductId *string `json:"product_id,omitempty"`

	// 设备关联的产品名称。
	ProductName *string `json:"product_name,omitempty"`

	// 设备的状态。 - ONLINE：设备在线。 - OFFLINE：设备离线。 - ABNORMAL：设备异常。 - INACTIVE：设备未激活。 - FROZEN：设备冻结。
	Status *string `json:"status,omitempty"`

	// 设备的标签列表。
	Tags *[]TagV5Dto `json:"tags,omitempty"`
}

设备信息结构体，批量查询返回。

func (QueryDeviceSimplify) String 

func (o QueryDeviceSimplify) String() string

type QueryQueueBase 

type QueryQueueBase struct {

	// 队列ID，用于唯一标识一个队列。
	QueueId *string `json:"queue_id,omitempty"`

	// 队列名称，同一租户不允许重复。
	QueueName *string `json:"queue_name,omitempty"`

	// 在物联网平台创建队列的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 在物联网平台最后修改队列的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	LastModifyTime *string `json:"last_modify_time,omitempty"`
}

队列信息结构体，返回基本信息。

func (QueryQueueBase) String 

func (o QueryQueueBase) String() string

type QueryResourceByTagsDto 

type QueryResourceByTagsDto struct {

	// **参数说明**：要查询的资源类型，当前支持设备（device）。
	ResourceType string `json:"resource_type"`

	// **参数说明**：标签列表，支持按照标签key和value组合查询，传入的多个标签之间是或的关系。
	Tags []TagV5Dto `json:"tags"`
}

按标签查询资源请求结构体。

func (QueryResourceByTagsDto) String 

func (o QueryResourceByTagsDto) String() string

type QueueInfo 

type QueueInfo struct {

	// **参数说明**：队列名称，同一租户不允许重复。 **取值范围**：长度不低于8不超过128，只允许字母、数字、下划线（_）、连接符（-）、间隔号（.）、冒号（:）的组合。
	QueueName string `json:"queue_name"`
}

添加时队列结构体。

func (QueueInfo) String 

func (o QueueInfo) String() string

type ResetDeviceSecret 

type ResetDeviceSecret struct {

	// **参数说明**：设备密钥，设置该字段时平台将设备密钥重置为指定值，若不设置则由平台自动生成。 **取值范围**：长度不低于8不超过32，只允许字母、数字、下划线（_）、连接符（-）的组合。
	Secret *string `json:"secret,omitempty"`

	// **参数说明**：是否强制断开设备的连接，当前仅限长连接。默认值false。
	ForceDisconnect *bool `json:"force_disconnect,omitempty"`
}

func (ResetDeviceSecret) String 

func (o ResetDeviceSecret) String() string

type ResetDeviceSecretRequest 

type ResetDeviceSecretRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

	// **参数说明**：对设备执行的操作。 **取值范围**： - resetSecret: 重置密钥。注意：NB设备密钥由于协议特殊性，只支持十六进制密钥接入。
	ActionId string `json:"action_id"`

	Body *ResetDeviceSecret `json:"body,omitempty"`
}

Request Object

func (ResetDeviceSecretRequest) String 

func (o ResetDeviceSecretRequest) String() string

type ResetDeviceSecretResponse 

type ResetDeviceSecretResponse struct {

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备密钥。
	Secret         *string `json:"secret,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ResetDeviceSecretResponse) String 

func (o ResetDeviceSecretResponse) String() string

type ResetFingerprint added in v0.0.81 

type ResetFingerprint struct {

	// **参数说明**：设备指纹。设置该字段时平台将设备指纹重置为指定值；不携带时将之置空，后续设备第一次接入时，该设备指纹的值将设置为第一次接入时的证书指纹。 **取值范围**：长度为40的十六进制字符串或者长度为64的十六进制字符串。
	Fingerprint *string `json:"fingerprint,omitempty"`

	// **参数说明**：是否强制断开设备的连接，当前仅限长连接。默认值false。
	ForceDisconnect *bool `json:"force_disconnect,omitempty"`
}

func (ResetFingerprint) String added in v0.0.81 

func (o ResetFingerprint) String() string

type ResetFingerprintRequest added in v0.0.81 

type ResetFingerprintRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

	Body *ResetFingerprint `json:"body,omitempty"`
}

Request Object

func (ResetFingerprintRequest) String added in v0.0.81 

func (o ResetFingerprintRequest) String() string

type ResetFingerprintResponse added in v0.0.81 

type ResetFingerprintResponse struct {

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备指纹。
	Fingerprint    *string `json:"fingerprint,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ResetFingerprintResponse) String added in v0.0.81 

func (o ResetFingerprintResponse) String() string

type ResourceDto 

type ResourceDto struct {

	// 资源id。例如，要查询的资源类型为device，那么对应的资源id就是device_id。
	ResourceId *string `json:"resource_id,omitempty"`
}

资源结构体。

func (ResourceDto) String 

func (o ResourceDto) String() string

type RetryBatchTaskRequest added in v0.1.43 

type RetryBatchTaskRequest struct {

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

	// **参数说明**：批量任务ID，创建批量任务时由物联网平台分配获得。 **取值范围**：长度不超过24，只允许小写字母a到f、数字的组合。
	TaskId string `json:"task_id"`

	Body *BatchTargets `json:"body,omitempty"`
}

Request Object

func (RetryBatchTaskRequest) String added in v0.1.43 

func (o RetryBatchTaskRequest) String() string

type RetryBatchTaskResponse added in v0.1.43 

type RetryBatchTaskResponse struct {

	// 批量操作目标结果集合
	Targets        *[]BatchTargetResult `json:"targets,omitempty"`
	HttpStatusCode int                  `json:"-"`
}

Response Object

func (RetryBatchTaskResponse) String added in v0.1.43 

func (o RetryBatchTaskResponse) String() string

type RomaForwarding 

type RomaForwarding struct {

	// **参数说明**：转发roma消息对应的地址列表
	Addresses []NetAddress `json:"addresses"`

	// **参数说明**：转发roma消息关联的topic信息。
	Topic string `json:"topic"`

	// **参数说明**：转发roma关联的用户名信息。
	Username string `json:"username"`

	// **参数说明**：转发roma关联的密码信息。
	Password string `json:"password"`
}

转发roma消息结构

func (RomaForwarding) String 

func (o RomaForwarding) String() string

type RoutingRule 

type RoutingRule struct {

	// 规则触发条件ID，用于唯一标识一个规则触发条件，在创建规则条件时由物联网平台分配获得。
	RuleId *string `json:"rule_id,omitempty"`

	// 用户自定义的规则名称。
	RuleName *string `json:"rule_name,omitempty"`

	// 用户自定义的规则描述。
	Description *string `json:"description,omitempty"`

	Subject *RoutingRuleSubject `json:"subject,omitempty"`

	// 租户规则的生效范围，取值如下： - GLOBAL：生效范围为租户级 - APP：生效范围为资源空间级。
	AppType *string `json:"app_type,omitempty"`

	// 资源空间ID
	AppId *string `json:"app_id,omitempty"`

	// 用户自定义sql select语句，最大长度2500，该参数仅供标准版和企业版用户使用。
	Select *string `json:"select,omitempty"`

	// 用户自定义sql where语句，最大长度2500，该参数仅供标准版和企业版用户使用。
	Where *string `json:"where,omitempty"`

	// 规则条件的状态是否为激活。
	Active *bool `json:"active,omitempty"`
}

创建或修改规则条件的响应消息

func (RoutingRule) String 

func (o RoutingRule) String() string

type RoutingRuleAction 

type RoutingRuleAction struct {

	// 规则动作ID，用于唯一标识一条规则动作，在创建规则动作时由物联网平台分配获得，创建时无需携带，由平台统一分配唯一的action_id。
	ActionId *string `json:"action_id,omitempty"`

	// 规则动作对应的的规则触发条件ID。
	RuleId *string `json:"rule_id,omitempty"`

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 规则动作的类型，取值范围： - HTTP_FORWARDING：HTTP服务消息类型。 - DIS_FORWARDING：转发DIS服务消息类型。 - OBS_FORWARDING：转发OBS服务消息类型。 - AMQP_FORWARDING：转发AMQP服务消息类型。 - DMS_KAFKA_FORWARDING：转发kafka消息类型。 [- ROMA_FORWARDING: 转发Roma消息类型。（仅企业版支持）](tag:hws) - INFLUXDB_FORWARDING：转发InfluxDB消息类型。[（仅标准版和企业版支持）](tag:hws) - MYSQL_FORWARDING：转发MySQL消息类型。[（仅标准版和企业版支持）](tag:hws) - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。[（仅标准版和企业版支持）](tag:hws) [- MRS_KAFKA_FORWARDING：转发MRS_KAFKA消息类型。（仅企业版支持）](tag:hws) [- DMS_ROCKETMQ_FORWARDING：转发RocketMQ消息类型。（仅标准版和企业版支持）](tag:hws)
	Channel *string `json:"channel,omitempty"`

	ChannelDetail *ChannelDetail `json:"channel_detail,omitempty"`
}

创建或修改规则动作响应结构体

func (RoutingRuleAction) String 

func (o RoutingRuleAction) String() string

type RoutingRuleSubject 

type RoutingRuleSubject struct {

	// **参数说明**：资源名称。 **取值范围**： - device：设备。 - device.property：设备属性。 - device.message：设备消息。 - device.message.status：设备消息状态。 - device.status：设备状态。 - batchtask：批量任务。 - product：产品。 - device.command.status：设备异步命令状态。
	Resource string `json:"resource"`

	// **参数说明**：资源事件。 **取值范围**：与资源有关，不同的资源，事件不同。event需要与resource关联使用，具体的“resource：event”映射关系如下： - device：create（设备添加） - device：delete（设备删除） - device：update（设备更新） - device.status：update （设备状态变更） - device.property：report（设备属性上报） - device.message：report（设备消息上报） - device.message.status：update（设备消息状态变更） - batchtask：update （批量任务状态变更） - product：create（产品添加） - product：delete（产品删除） - product：update（产品更新） - device.command.status：update（设备异步命令状态更新）
	Event string `json:"event"`
}

创建或修改规则条件时，指定资源及其范围

func (RoutingRuleSubject) String 

func (o RoutingRuleSubject) String() string

type Rule 

type Rule struct {

	// **参数说明**：规则名称。
	Name string `json:"name"`

	// **参数说明**：规则的描述信息。
	Description *string `json:"description,omitempty"`

	ConditionGroup *ConditionGroup `json:"condition_group"`

	// **参数说明**：规则的动作列表，单个规则最多支持设置10个动作。
	Actions []RuleAction `json:"actions"`

	// **参数说明**：规则的类型。 **取值范围**： - DEVICE_LINKAGE：云端联动规则。  - DEVICE_SIDE：端侧规则。
	RuleType string `json:"rule_type"`

	// **参数说明**：规则的状态，默认值：active。 **取值范围**： - active：激活。 - inactive：未激活。
	Status *string `json:"status,omitempty"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的规则归属到哪个资源空间下，否则创建的规则将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	DeviceSide *DeviceSide `json:"device_side,omitempty"`
}

规则请求结构体

func (Rule) String 

func (o Rule) String() string

type RuleAction 

type RuleAction struct {

	// **参数说明**：规则动作的类型，端侧执行只支持下发设备命令消息类型。 **取值范围**： - DEVICE_CMD：下发设备命令消息类型。 - SMN_FORWARDING：发送SMN消息类型。 - DEVICE_ALARM：上报设备告警消息类型。当选择该类型时，condition中必须有DEVICE_DATA条件类型。该类型动作只能唯一。
	Type string `json:"type"`

	DeviceCommand *ActionDeviceCommand `json:"device_command,omitempty"`

	SmnForwarding *ActionSmnForwarding `json:"smn_forwarding,omitempty"`

	DeviceAlarm *ActionDeviceAlarm `json:"device_alarm,omitempty"`
}

规则动作结构体

func (RuleAction) String 

func (o RuleAction) String() string

type RuleCondition 

type RuleCondition struct {

	// **参数说明**：规则条件的类型。 **取值范围**： - DEVICE_DATA：设备属性数据类型条件。 - SIMPLE_TIMER：简单定时类型条件。 - DAILY_TIMER：每日定时类型条件。 - DEVICE_LINKAGE_STATUS：设备状态类型条件。
	Type string `json:"type"`

	DevicePropertyCondition *DeviceDataCondition `json:"device_property_condition,omitempty"`

	SimpleTimerCondition *SimpleTimerType `json:"simple_timer_condition,omitempty"`

	DailyTimerCondition *DailyTimerType `json:"daily_timer_condition,omitempty"`

	DeviceLinkageStatusCondition *DeviceLinkageStatusCondition `json:"device_linkage_status_condition,omitempty"`
}

规则条件结构体

func (RuleCondition) String 

func (o RuleCondition) String() string

type RuleResponse 

type RuleResponse struct {

	// 规则id。
	RuleId *string `json:"rule_id,omitempty"`

	// 规则名称。
	Name string `json:"name"`

	// 规则的描述信息。
	Description *string `json:"description,omitempty"`

	ConditionGroup *ConditionGroup `json:"condition_group"`

	// 规则的动作列表，单个规则最多支持设置10个动作。
	Actions []RuleAction `json:"actions"`

	// 规则的类型 - DEVICE_LINKAGE：云端联动规则。 - DEVICE_SIDE：端侧规则。
	RuleType string `json:"rule_type"`

	// 规则的状态，默认值：active。 - active：激活。 - inactive：未激活。
	Status *string `json:"status,omitempty"`

	// 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的规则归属到哪个资源空间下，否则创建的规则将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。
	AppId *string `json:"app_id,omitempty"`

	// 归属边缘侧节点设备ID列表。
	EdgeNodeIds *[]string `json:"edge_node_ids,omitempty"`

	// 规则最后更新时间，使用UTC时区，格式：yyyyMMdd'T'HHmmss'Z'。
	LastUpdateTime *string `json:"last_update_time,omitempty"`

	DeviceSide *DeviceSide `json:"device_side,omitempty"`
}

规则响应结构体

func (RuleResponse) String 

func (o RuleResponse) String() string

type RuleStatus 

type RuleStatus struct {

	// **参数说明**：规则的激活状态。 **取值范围**： - active：激活。 - inactive：未激活。
	Status string `json:"status"`
}

规则状态

func (RuleStatus) String 

func (o RuleStatus) String() string

type SearchDevice added in v0.1.18 

type SearchDevice struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。
	NodeId *string `json:"node_id,omitempty"`

	// 网关ID，用于标识设备所属的父设备，即父设备的设备ID。当设备是直连设备时，gateway_id与设备的device_id一致。当设备是非直连设备时，gateway_id为设备所关联的父设备的device_id。
	GatewayId *string `json:"gateway_id,omitempty"`

	// 设备名称。
	DeviceName *string `json:"device_name,omitempty"`

	// 设备节点类型。 - ENDPOINT：非直连设备。 - GATEWAY：直连设备或网关。 - UNKNOWN：未知。
	NodeType *string `json:"node_type,omitempty"`

	// 设备的固件版本。
	FwVersion *string `json:"fw_version,omitempty"`

	// 设备的软件版本。
	SwVersion *string `json:"sw_version,omitempty"`

	// 设备的sdk信息。
	DeviceSdkVersion *string `json:"device_sdk_version,omitempty"`

	// 设备关联的产品ID，用于唯一标识一个产品模型。
	ProductId *string `json:"product_id,omitempty"`

	// 设备关联的产品名称。
	ProductName *string `json:"product_name,omitempty"`

	// 设备组列表。
	Groups *interface{} `json:"groups,omitempty"`

	// 设备的状态。 - ONLINE：设备在线。 - OFFLINE：设备离线。 - ABNORMAL：设备异常。 - INACTIVE：设备未激活。 - FROZEN：设备冻结。
	Status *string `json:"status,omitempty"`

	// 设备的标签列表。
	Tags *interface{} `json:"tags,omitempty"`

	// 搜索结果记录Id。
	Marker *string `json:"marker,omitempty"`
}

设备搜索结果结构体

func (SearchDevice) String added in v0.1.18 

func (o SearchDevice) String() string

type SearchDevicesRequest added in v0.1.18 

type SearchDevicesRequest struct {

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

	Body *SearchSql `json:"body,omitempty"`
}

Request Object

func (SearchDevicesRequest) String added in v0.1.18 

func (o SearchDevicesRequest) String() string

type SearchDevicesResponse added in v0.1.18 

type SearchDevicesResponse struct {

	// 搜索设备结果列表。
	Devices *[]SearchDevice `json:"devices,omitempty"`

	// 满足查询条件的记录总数(只有条件为select count(*)/count(1)时单独返回)。
	Count          *int64 `json:"count,omitempty"`
	HttpStatusCode int    `json:"-"`
}

Response Object

func (SearchDevicesResponse) String added in v0.1.18 

func (o SearchDevicesResponse) String() string

type SearchSql added in v0.1.18 

type SearchSql struct {

	// 搜索sql语句，具体使用方法见类SQL语法使用说明章节
	Sql string `json:"sql"`
}

设备搜索请求结构体。

func (SearchSql) String added in v0.1.18 

func (o SearchSql) String() string

type ServiceCapability 

type ServiceCapability struct {

	// **参数说明**：设备的服务ID。注：产品内不允许重复。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。
	ServiceId string `json:"service_id"`

	// **参数说明**：设备的服务类型。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。
	ServiceType string `json:"service_type"`

	// **参数说明**：设备服务支持的属性列表。 **取值范围**：数组长度大小不超过500。
	Properties *[]ServiceProperty `json:"properties,omitempty"`

	// **参数说明**：设备服务支持的命令列表。 **取值范围**：数组长度大小不超过500。
	Commands *[]ServiceCommand `json:"commands,omitempty"`

	// **参数说明**：设备服务支持的事件列表。目前暂未支持自定义事件，创建/修改产品时无需定义该字段。 **取值范围**：数组长度大小不超过500。
	Events *[]ServiceEvent `json:"events,omitempty"`

	// **参数说明**：设备服务的描述信息。 **取值范围**：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。/等字符的组合。
	Description *string `json:"description,omitempty"`

	// **参数说明**：指定设备服务是否必选。目前本字段为非功能性字段，仅起到标识作用。 **取值范围**： - Master：主服务 - Mandatory：必选服务 - Optional：可选服务 默认值为Optional。
	Option *string `json:"option,omitempty"`
}

ServiceCapability结构体。

func (ServiceCapability) String 

func (o ServiceCapability) String() string

type ServiceCommand 

type ServiceCommand struct {

	// **参数说明**：设备命令名称。注：设备服务内不允许重复。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	CommandName string `json:"command_name"`

	// **参数说明**：设备命令的参数列表。
	Paras *[]ServiceCommandPara `json:"paras,omitempty"`

	// **参数说明**：设备命令的响应列表。
	Responses *[]ServiceCommandResponse `json:"responses,omitempty"`
}

命令服务对象。

func (ServiceCommand) String 

func (o ServiceCommand) String() string

type ServiceCommandPara 

type ServiceCommandPara struct {

	// **参数说明**：参数的名称。 **取值范围**：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	ParaName string `json:"para_name"`

	// **参数说明**：参数的数据类型。 **取值范围**：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。
	DataType string `json:"data_type"`

	// **参数说明**：参数是否必选。默认为false。
	Required *bool `json:"required,omitempty"`

	// **参数说明**：参数的枚举值列表。
	EnumList *[]string `json:"enum_list,omitempty"`

	// **参数说明**：参数的最小值。 **取值范围**：长度1-16。
	Min *string `json:"min,omitempty"`

	// **参数说明**：参数的最大值。 **取值范围**：长度1-16。
	Max *string `json:"max,omitempty"`

	// **参数说明**：参数的最大长度。
	MaxLength *int32 `json:"max_length,omitempty"`

	// **参数说明**：参数的步长。
	Step *float64 `json:"step,omitempty"`

	// **参数说明**：参数的单位。 **取值范围**：长度不超过16。
	Unit *string `json:"unit,omitempty"`

	// **参数说明**：参数的描述。 **取值范围**：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。/等字符的组合。
	Description *string `json:"description,omitempty"`
}

参数服务对象。

func (ServiceCommandPara) String 

func (o ServiceCommandPara) String() string

type ServiceCommandResponse 

type ServiceCommandResponse struct {

	// **参数说明**：设备命令响应名称。 **取值范围**：长度不超过128，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	ResponseName string `json:"response_name"`

	// **参数说明**：设备命令响应的参数列表。
	Paras *[]ServiceCommandPara `json:"paras,omitempty"`
}

命令参数响应对象。

func (ServiceCommandResponse) String 

func (o ServiceCommandResponse) String() string

type ServiceEvent 

type ServiceEvent struct {

	// **参数说明**：设备事件类型。注：设备服务内不允许重复。 **取值范围**：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	EventType string `json:"event_type"`

	// **参数说明**：设备事件的参数列表。
	Paras *[]ServiceCommandPara `json:"paras,omitempty"`
}

事件服务对象。

func (ServiceEvent) String 

func (o ServiceEvent) String() string

type ServiceProperty 

type ServiceProperty struct {

	// **参数说明**：设备属性名称。注：设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)，如果包含了以上特殊字符则无法正常刷新影子文档。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	PropertyName string `json:"property_name"`

	// **参数说明**：设备属性的数据类型。 **取值范围**：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。
	DataType string `json:"data_type"`

	// **参数说明**：设备属性是否必选。默认为false。
	Required *bool `json:"required,omitempty"`

	// **参数说明**：设备属性的枚举值列表。
	EnumList *[]string `json:"enum_list,omitempty"`

	// **参数说明**：设备属性的最小值。 **取值范围**：长度1-16。
	Min *string `json:"min,omitempty"`

	// **参数说明**：设备属性的最大值。 **取值范围**：长度1-16。
	Max *string `json:"max,omitempty"`

	// **参数说明**：设备属性的最大长度。
	MaxLength *int32 `json:"max_length,omitempty"`

	// **参数说明**：设备属性的步长。
	Step *float64 `json:"step,omitempty"`

	// **参数说明**：设备属性的单位。 **取值范围**：长度不超过16。
	Unit *string `json:"unit,omitempty"`

	// **参数说明**：设备属性的访问模式。 **取值范围**：RWE，RW，RE，WE，E，W，R。 - R：属性值可读 - W：属性值可写 - E：属性值可订阅，即属性值变化时上报事件
	Method string `json:"method"`

	// **参数说明**：设备属性的描述。 **取值范围**：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。/等字符的组合。
	Description *string `json:"description,omitempty"`

	// **参数说明**：设备属性的默认值。如果设置了默认值，使用该产品创建设备时，会将该属性的默认值写入到该设备的设备影子预期数据中，待设备上线时将该属性默认值下发给设备。
	DefaultValue *interface{} `json:"default_value,omitempty"`
}

属性服务对象。

func (ServiceProperty) String 

func (o ServiceProperty) String() string

type ShowApplicationRequest 

type ShowApplicationRequest struct {

	// **参数说明**：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	// **参数说明**：资源空间ID，唯一标识一个资源空间，由物联网平台在创建资源空间时分配。资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId string `json:"app_id"`
}

Request Object

func (ShowApplicationRequest) String 

func (o ShowApplicationRequest) String() string

type ShowApplicationResponse 

type ShowApplicationResponse struct {

	// 资源空间ID，唯一标识一个资源空间，由物联网平台在创建资源空间时分配。资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 资源空间创建时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 是否为默认资源空间
	DefaultApp     *bool `json:"default_app,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ShowApplicationResponse) String 

func (o ShowApplicationResponse) String() string

type ShowApplicationsRequest 

type ShowApplicationsRequest struct {

	// **参数说明**：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
	InstanceId *string `json:"Instance-Id,omitempty"`

	// **参数说明**：默认资源空间标识，不携带则查询所有资源空间。 **取值范围**： - true：查询默认资源空间。 - false：查询非默认资源空间。
	DefaultApp *bool `json:"default_app,omitempty"`
}

Request Object

func (ShowApplicationsRequest) String 

func (o ShowApplicationsRequest) String() string

type ShowApplicationsResponse 

type ShowApplicationsResponse struct {

	// 资源空间信息列表。
	Applications   *[]ApplicationDto `json:"applications,omitempty"`
	HttpStatusCode int               `json:"-"`
}

Response Object

func (ShowApplicationsResponse) String 

func (o ShowApplicationsResponse) String() string

type ShowAsyncDeviceCommandRequest 

type ShowAsyncDeviceCommandRequest struct {

	// **参数说明**：下发命令的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

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

	// **参数说明**：下发命令的命令id，用于唯一标识一个消息，在下发命令时由物联网平台分配获得。 **取值范围**：长度不超过100，只允许字母、数字、下划线（_）、连接符（-）的组合。
	CommandId string `json:"command_id"`
}

Request Object

func (ShowAsyncDeviceCommandRequest) String 

func (o ShowAsyncDeviceCommandRequest) String() string

type ShowAsyncDeviceCommandResponse 

type ShowAsyncDeviceCommandResponse struct {

	// 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。
	CommandId *string `json:"command_id,omitempty"`

	// 设备命令所属的设备服务ID，在设备关联的产品模型中定义。
	ServiceId *string `json:"service_id,omitempty"`

	// 设备命令名称，在设备关联的产品模型中定义。
	CommandName *string `json:"command_name,omitempty"`

	// 设备执行的命令，Json格式，里面是一个个健值对，如果service_id不为空，每个健都是profile中命令的参数名（paraName）;如果service_id为空则由用户自定义命令格式。设备命令示例：{\"value\":\"1\"}，具体格式需要应用和设备约定。
	Paras *interface{} `json:"paras,omitempty"`

	// 物联网平台缓存命令的时长， 单位秒。
	ExpireTime *int32 `json:"expire_time,omitempty"`

	// 下发命令的状态。 ·PENDING表示未下发,在物联网平台缓存着 ·EXPIRED表示命令已经过期，即缓存的时间超过设定的expire_time ·SENT表示命令正在下发 ·DELIVERED表示命令已送达设备 ·SUCCESSFUL表示命令已经成功执行 ·FAILED表示命令执行失败 ·TIMEOUT表示命令下发之后，没有收到设备确认或者响应结果一定时间后超时
	Status *string `json:"status,omitempty"`

	// 设备命令执行的详细结果，由设备返回，Json格式。
	Result *interface{} `json:"result,omitempty"`

	// 命令的创建时间，\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串。
	CreatedTime *string `json:"created_time,omitempty"`

	// 物联网平台发送命令的时间，如果命令是立即下发， 则该时间与命令创建时间一致， 如果是缓存命令， 则是命令实际下发的时间。\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串。
	SentTime *string `json:"sent_time,omitempty"`

	// 物联网平台将命令送达到设备的时间，\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串
	DeliveredTime *string `json:"delivered_time,omitempty"`

	// 下发策略， immediately表示立即下发，delay表示缓存起来，等数据上报或者设备上线之后下发。
	SendStrategy *string `json:"send_strategy,omitempty"`

	// 设备响应命令的时间，\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串
	ResponseTime   *string `json:"response_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowAsyncDeviceCommandResponse) String 

func (o ShowAsyncDeviceCommandResponse) String() string

type ShowBatchTaskRequest 

type ShowBatchTaskRequest struct {

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

	// **参数说明**：批量任务ID，创建批量任务时由物联网平台分配获得。 **取值范围**：长度不超过24，只允许小写字母a到f、数字的组合。
	TaskId string `json:"task_id"`

	// **参数说明**：子任务的执行状态，可选参数。 **取值范围**： - Success: 成功。 - Fail: 失败。 - Processing: 执行中。 - FailWaitRetry: 失败重试。 - Stopped: 已停止。 - Waitting: 等待执行。 - Removed: 已移除。
	TaskDetailStatus *string `json:"task_detail_status,omitempty"`

	// **参数说明**：执行批量任务的目标，当task_type为firmwareUpgrade，softwareUpgrade，deleteDevices，freezeDevices，unfreezeDevices，createCommands，createAsyncCommands，createMessages，updateDeviceShadows，此处填写device_id **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	Target *string `json:"target,omitempty"`

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从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。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ShowBatchTaskRequest) String 

func (o ShowBatchTaskRequest) String() string

type ShowBatchTaskResponse 

type ShowBatchTaskResponse struct {
	Batchtask *Task `json:"batchtask,omitempty"`

	// 子任务详情列表。
	TaskDetails *[]TaskDetail `json:"task_details,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ShowBatchTaskResponse) String 

func (o ShowBatchTaskResponse) String() string

type ShowDeviceGroupRequest 

type ShowDeviceGroupRequest struct {

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

	// **参数说明**：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。 **取值范围**：长度不超过36，十六进制字符串和连接符（-）的组合。
	GroupId string `json:"group_id"`
}

Request Object

func (ShowDeviceGroupRequest) String 

func (o ShowDeviceGroupRequest) String() string

type ShowDeviceGroupResponse 

type ShowDeviceGroupResponse struct {

	// 设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。
	GroupId *string `json:"group_id,omitempty"`

	// 设备组名称，单个资源空间下不可重复。
	Name *string `json:"name,omitempty"`

	// 设备组描述。
	Description *string `json:"description,omitempty"`

	// 父设备组ID，该设备组的父设备组ID。
	SuperGroupId *string `json:"super_group_id,omitempty"`

	// 设备组类型，分为动态设备组和静态设备组两种
	GroupType *string `json:"group_type,omitempty"`

	// 动态设备组规则
	DynamicGroupRule *string `json:"dynamic_group_rule,omitempty"`
	HttpStatusCode   int     `json:"-"`
}

Response Object

func (ShowDeviceGroupResponse) String 

func (o ShowDeviceGroupResponse) String() string

type ShowDeviceMessageRequest 

type ShowDeviceMessageRequest struct {

	// **参数说明**：下发消息的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

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

	// **参数说明**：下发消息的消息ID，用于唯一标识一个消息，在消息下发时由物联网平台分配获得。 **取值范围**：长度不超过100，只允许字母、数字、下划线（_）、连接符（-）的组合。
	MessageId string `json:"message_id"`
}

Request Object

func (ShowDeviceMessageRequest) String 

func (o ShowDeviceMessageRequest) String() string

type ShowDeviceMessageResponse 

type ShowDeviceMessageResponse struct {

	// 设备消息ID，用于唯一标识一条消息，在下发设备消息时由物联网平台分配获得。
	MessageId *string `json:"message_id,omitempty"`

	// 消息名称,在下发消息时由用户指定。
	Name *string `json:"name,omitempty"`

	// 消息内容。
	Message *interface{} `json:"message,omitempty"`

	// 消息内容编码格式，取值范围none|base64,默认值none, base64格式仅支持透传。
	Encoding *string `json:"encoding,omitempty"`

	// 有效负载格式，在消息内容编码格式为none时有效，取值范围standard|raw，默认值standard（平台封装的标准格式），取值为raw时直接将消息内容作为有效负载下发。
	PayloadFormat *string `json:"payload_format,omitempty"`

	// 消息topic
	Topic *string `json:"topic,omitempty"`

	Properties *PropertiesDto `json:"properties,omitempty"`

	// 消息状态，包含PENDING，DELIVERED，FAILED和TIMEOUT，PENDING指设备不在线，消息被缓存起来，等设备上线之后下发； DELIVERED指消息发送成功；FAILED消息发送失败；TIMEOUT指消息在平台默认时间内（1天）还没有下发送给设备，则平台会将消息设置为超时，状态为TIMEOUT。
	Status *string `json:"status,omitempty"`

	ErrorInfo *ErrorInfoDto `json:"error_info,omitempty"`

	// 消息的创建时间，\"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串。
	CreatedTime *string `json:"created_time,omitempty"`

	// 消息结束时间, \"yyyyMMdd'T'HHmmss'Z'\"格式的UTC字符串，包含消息转换到DELIVERED和TIMEOUT两个状态的时间。
	FinishedTime   *string `json:"finished_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowDeviceMessageResponse) String 

func (o ShowDeviceMessageResponse) String() string

type ShowDeviceRequest 

type ShowDeviceRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`
}

Request Object

func (ShowDeviceRequest) String 

func (o ShowDeviceRequest) String() string

type ShowDeviceResponse 

type ShowDeviceResponse struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。
	NodeId *string `json:"node_id,omitempty"`

	// 网关ID，用于标识设备所属的父设备，即父设备的设备ID。当设备是直连设备时，gateway_id与设备的device_id一致。当设备是非直连设备时，gateway_id为设备所关联的父设备的device_id。
	GatewayId *string `json:"gateway_id,omitempty"`

	// 设备名称。
	DeviceName *string `json:"device_name,omitempty"`

	// 设备节点类型。 - ENDPOINT：非直连设备。 - GATEWAY：直连设备或网关。 - UNKNOWN：未知。
	NodeType *string `json:"node_type,omitempty"`

	// 设备的描述信息。
	Description *string `json:"description,omitempty"`

	// 设备的固件版本。
	FwVersion *string `json:"fw_version,omitempty"`

	// 设备的软件版本。
	SwVersion *string `json:"sw_version,omitempty"`

	// 设备的sdk信息。
	DeviceSdkVersion *string `json:"device_sdk_version,omitempty"`

	AuthInfo *AuthInfo `json:"auth_info,omitempty"`

	// 设备关联的产品ID，用于唯一标识一个产品模型。
	ProductId *string `json:"product_id,omitempty"`

	// 设备关联的产品名称。
	ProductName *string `json:"product_name,omitempty"`

	// 设备的状态。 - ONLINE：设备在线。 - OFFLINE：设备离线。 - ABNORMAL：设备异常。 - INACTIVE：设备未激活。 - FROZEN：设备冻结。
	Status *string `json:"status,omitempty"`

	// 在物联网平台注册设备的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 设备最近一次连接状态(ONLINE:在线，OFFLINE：离线，ABNORMAL：异常)变化时间。格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ，如2015-12-12T12:12:122Z。
	ConnectionStatusUpdateTime *string `json:"connection_status_update_time,omitempty"`

	// 设备激活时间。格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ，如2015-12-12T12:12:122Z。
	ActiveTime *string `json:"active_time,omitempty"`

	// 设备的标签列表。
	Tags *[]TagV5Dto `json:"tags,omitempty"`

	// 设备扩展信息。用户可以自定义任何想要的扩展信息，如果在创建设备时为子设备指定该字段，将会通过MQTT接口“平台通知网关子设备新增“将该信息通知给网关。
	ExtensionInfo  *interface{} `json:"extension_info,omitempty"`
	HttpStatusCode int          `json:"-"`
}

Response Object

func (ShowDeviceResponse) String 

func (o ShowDeviceResponse) String() string

type ShowDeviceShadowRequest 

type ShowDeviceShadowRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`
}

Request Object

func (ShowDeviceShadowRequest) String 

func (o ShowDeviceShadowRequest) String() string

type ShowDeviceShadowResponse 

type ShowDeviceShadowResponse struct {

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备影子数据结构体。
	Shadow         *[]DeviceShadowData `json:"shadow,omitempty"`
	HttpStatusCode int                 `json:"-"`
}

Response Object

func (ShowDeviceShadowResponse) String 

func (o ShowDeviceShadowResponse) String() string

type ShowDevicesInGroupRequest 

type ShowDevicesInGroupRequest struct {

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

	// **参数说明**：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。 **取值范围**：长度不超过36，十六进制字符串和连接符（-）的组合。
	GroupId string `json:"group_id"`

	// **参数说明**：分页查询时每页显示的记录数。 **取值范围**：1-50的整数，默认值为10。
	Limit *int32 `json:"limit,omitempty"`

	// **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
	Marker *string `json:"marker,omitempty"`

	// **参数说明**：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 **取值范围**：0-500的整数，默认为0。
	Offset *int32 `json:"offset,omitempty"`
}

Request Object

func (ShowDevicesInGroupRequest) String 

func (o ShowDevicesInGroupRequest) String() string

type ShowDevicesInGroupResponse 

type ShowDevicesInGroupResponse struct {

	// 设备列表。
	Devices *[]SimplifyDevice `json:"devices,omitempty"`

	Page           *Page `json:"page,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ShowDevicesInGroupResponse) String 

func (o ShowDevicesInGroupResponse) String() string

type ShowOtaPackageRequest added in v0.1.28 

type ShowOtaPackageRequest struct {

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

	// **参数说明**：升级包ID，用于唯一标识一个升级包。由物联网平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、连接符（-）的组合。
	PackageId string `json:"package_id"`
}

Request Object

func (ShowOtaPackageRequest) String added in v0.1.28 

func (o ShowOtaPackageRequest) String() string

type ShowOtaPackageResponse added in v0.1.28 

type ShowOtaPackageResponse struct {

	// **参数说明**：升级包ID，用于唯一标识一个升级包。由物联网平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、连接符（-）的组合。
	PackageId *string `json:"package_id,omitempty"`

	// **参数说明**：资源空间ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：升级包类型。 **取值范围**：软件包必须设置为：softwarePackage，固件包必须设置为：firmwarePackage。
	PackageType *string `json:"package_type,omitempty"`

	// **参数说明**：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 [[创建产品](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)](tag:hws)[[创建产品](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0050.html)](tag:hws_hk)。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId *string `json:"product_id,omitempty"`

	// **参数说明**：升级包版本号。 **取值范围**：长度不超过256，只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	Version *string `json:"version,omitempty"`

	// **参数说明**：支持用于升级此版本包的设备源版本号列表。最多支持20个源版本号。 **取值范围**：源版本号列表，源版本号只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。
	SupportSourceVersions *[]string `json:"support_source_versions,omitempty"`

	// **参数说明**：用于描述升级包的功能等信息。 **取值范围**：长度不超过1024。
	Description *string `json:"description,omitempty"`

	// **参数说明**：推送给设备的自定义信息。添加该升级包完成，并创建升级任务后，物联网平台向设备下发升级通知时，会下发该自定义信息给设备。 **取值范围**：长度不超过4096。
	CustomInfo *string `json:"custom_info,omitempty"`

	// 软固件包上传到物联网平台的时间，格式：\"yyyyMMdd'T'HHmmss'Z'\"。
	CreateTime *string `json:"create_time,omitempty"`

	FileLocation   *FileLocation `json:"file_location,omitempty"`
	HttpStatusCode int           `json:"-"`
}

Response Object

func (ShowOtaPackageResponse) String added in v0.1.28 

func (o ShowOtaPackageResponse) String() string

type ShowProductRequest 

type ShowProductRequest struct {

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

	// **参数说明**：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId string `json:"product_id"`

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数，指定要查询的产品属于哪个资源空间；若不携带，则优先取默认资源空间下产品，如默认资源空间下无对应产品，则按照产品创建时间取最早创建产品。如果用户存在多资源空间，同时又不想携带该参数，可以联系华为技术支持对用户数据做资源空间合并。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`
}

Request Object

func (ShowProductRequest) String 

func (o ShowProductRequest) String() string

type ShowProductResponse 

type ShowProductResponse struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。
	ProductId *string `json:"product_id,omitempty"`

	// 产品名称。
	Name *string `json:"name,omitempty"`

	// 设备类型。
	DeviceType *string `json:"device_type,omitempty"`

	// 设备使用的协议类型。取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF， OPC-UA，OPC-DA，Other。
	ProtocolType *string `json:"protocol_type,omitempty"`

	// 设备上报数据的格式，取值范围：json，binary。
	DataFormat *string `json:"data_format,omitempty"`

	// 厂商名称。
	ManufacturerName *string `json:"manufacturer_name,omitempty"`

	// 设备所属行业。
	Industry *string `json:"industry,omitempty"`

	// 产品的描述信息。
	Description *string `json:"description,omitempty"`

	// 设备的服务能力列表。
	ServiceCapabilities *[]ServiceCapability `json:"service_capabilities,omitempty"`

	// 在物联网平台创建产品的时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime     *string `json:"create_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowProductResponse) String 

func (o ShowProductResponse) String() string

type ShowQueueRequest 

type ShowQueueRequest struct {

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

	// **参数说明**：队列ID，用于唯一标识一个队列。 **取值范围**：长度36位，只允许字母、数字、下划线（_）、连接符（-）的组合。
	QueueId string `json:"queue_id"`
}

Request Object

func (ShowQueueRequest) String 

func (o ShowQueueRequest) String() string

type ShowQueueResponse 

type ShowQueueResponse struct {

	// 队列ID，用于唯一标识一个队列。
	QueueId *string `json:"queue_id,omitempty"`

	// 队列名称，同一租户不允许重复。
	QueueName *string `json:"queue_name,omitempty"`

	// 在物联网平台创建队列的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 在物联网平台最后修改队列的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	LastModifyTime *string `json:"last_modify_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowQueueResponse) String 

func (o ShowQueueResponse) String() string

type ShowRoutingRuleRequest 

type ShowRoutingRuleRequest struct {

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

	// **参数说明**：规则条件ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	RuleId string `json:"rule_id"`
}

Request Object

func (ShowRoutingRuleRequest) String 

func (o ShowRoutingRuleRequest) String() string

type ShowRoutingRuleResponse 

type ShowRoutingRuleResponse struct {

	// 规则触发条件ID，用于唯一标识一个规则触发条件，在创建规则条件时由物联网平台分配获得。
	RuleId *string `json:"rule_id,omitempty"`

	// 用户自定义的规则名称。
	RuleName *string `json:"rule_name,omitempty"`

	// 用户自定义的规则描述。
	Description *string `json:"description,omitempty"`

	Subject *RoutingRuleSubject `json:"subject,omitempty"`

	// 租户规则的生效范围，取值如下： - GLOBAL：生效范围为租户级 - APP：生效范围为资源空间级。
	AppType *string `json:"app_type,omitempty"`

	// 资源空间ID
	AppId *string `json:"app_id,omitempty"`

	// 用户自定义sql select语句，最大长度2500，该参数仅供标准版和企业版用户使用。
	Select *string `json:"select,omitempty"`

	// 用户自定义sql where语句，最大长度2500，该参数仅供标准版和企业版用户使用。
	Where *string `json:"where,omitempty"`

	// 规则条件的状态是否为激活。
	Active         *bool `json:"active,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (ShowRoutingRuleResponse) String 

func (o ShowRoutingRuleResponse) String() string

type ShowRuleActionRequest 

type ShowRuleActionRequest struct {

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

	// **参数说明**：规则动作ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ActionId string `json:"action_id"`
}

Request Object

func (ShowRuleActionRequest) String 

func (o ShowRuleActionRequest) String() string

type ShowRuleActionResponse 

type ShowRuleActionResponse struct {

	// 规则动作ID，用于唯一标识一条规则动作，在创建规则动作时由物联网平台分配获得，创建时无需携带，由平台统一分配唯一的action_id。
	ActionId *string `json:"action_id,omitempty"`

	// 规则动作对应的的规则触发条件ID。
	RuleId *string `json:"rule_id,omitempty"`

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 规则动作的类型，取值范围： - HTTP_FORWARDING：HTTP服务消息类型。 - DIS_FORWARDING：转发DIS服务消息类型。 - OBS_FORWARDING：转发OBS服务消息类型。 - AMQP_FORWARDING：转发AMQP服务消息类型。 - DMS_KAFKA_FORWARDING：转发kafka消息类型。 [- ROMA_FORWARDING: 转发Roma消息类型。（仅企业版支持）](tag:hws) - INFLUXDB_FORWARDING：转发InfluxDB消息类型。[（仅标准版和企业版支持）](tag:hws) - MYSQL_FORWARDING：转发MySQL消息类型。[（仅标准版和企业版支持）](tag:hws) - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。[（仅标准版和企业版支持）](tag:hws) [- MRS_KAFKA_FORWARDING：转发MRS_KAFKA消息类型。（仅企业版支持）](tag:hws) [- DMS_ROCKETMQ_FORWARDING：转发RocketMQ消息类型。（仅标准版和企业版支持）](tag:hws)
	Channel *string `json:"channel,omitempty"`

	ChannelDetail  *ChannelDetail `json:"channel_detail,omitempty"`
	HttpStatusCode int            `json:"-"`
}

Response Object

func (ShowRuleActionResponse) String 

func (o ShowRuleActionResponse) String() string

type ShowRuleRequest 

type ShowRuleRequest struct {

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

	// **参数说明**：规则ID，用于唯一标识一条规则，在创建规则时由物联网平台分配获得。 **取值范围**：长度不超过32，只允许字母、数字的组合。
	RuleId string `json:"rule_id"`
}

Request Object

func (ShowRuleRequest) String 

func (o ShowRuleRequest) String() string

type ShowRuleResponse 

type ShowRuleResponse struct {

	// 规则id。
	RuleId *string `json:"rule_id,omitempty"`

	// 规则名称。
	Name *string `json:"name,omitempty"`

	// 规则的描述信息。
	Description *string `json:"description,omitempty"`

	ConditionGroup *ConditionGroup `json:"condition_group,omitempty"`

	// 规则的动作列表，单个规则最多支持设置10个动作。
	Actions *[]RuleAction `json:"actions,omitempty"`

	// 规则的类型 - DEVICE_LINKAGE：云端联动规则。 - DEVICE_SIDE：端侧规则。
	RuleType *string `json:"rule_type,omitempty"`

	// 规则的状态，默认值：active。 - active：激活。 - inactive：未激活。
	Status *string `json:"status,omitempty"`

	// 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的规则归属到哪个资源空间下，否则创建的规则将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。
	AppId *string `json:"app_id,omitempty"`

	// 归属边缘侧节点设备ID列表。
	EdgeNodeIds *[]string `json:"edge_node_ids,omitempty"`

	// 规则最后更新时间，使用UTC时区，格式：yyyyMMdd'T'HHmmss'Z'。
	LastUpdateTime *string `json:"last_update_time,omitempty"`

	DeviceSide     *DeviceSide `json:"device_side,omitempty"`
	HttpStatusCode int         `json:"-"`
}

Response Object

func (ShowRuleResponse) String 

func (o ShowRuleResponse) String() string

type SimpleTimerType 

type SimpleTimerType struct {

	// **参数说明**：规则触发的开始时间，使用UTC时区，格式：yyyyMMdd'T'HHmmss'Z'。
	StartTime string `json:"start_time"`

	// **参数说明**：规则触发的重复时间间隔，单位为秒。
	RepeatInterval int32 `json:"repeat_interval"`

	// **参数说明**：规则触发的重复次数。
	RepeatCount int32 `json:"repeat_count"`
}

条件中简单定时类型的信息，自定义结构。

func (SimpleTimerType) String 

func (o SimpleTimerType) String() string

type SimplifyDevice 

type SimplifyDevice struct {

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。
	NodeId *string `json:"node_id,omitempty"`

	// 设备名称。
	DeviceName *string `json:"device_name,omitempty"`

	// 设备关联的产品ID，用于唯一标识一个产品模型。
	ProductId *string `json:"product_id,omitempty"`
}

设备信息结构体，批量查询返回。

func (SimplifyDevice) String 

func (o SimplifyDevice) String() string

type StopBatchTaskRequest added in v0.1.43 

type StopBatchTaskRequest struct {

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

	// **参数说明**：批量任务ID，创建批量任务时由物联网平台分配获得。 **取值范围**：长度不超过24，只允许小写字母a到f、数字的组合。
	TaskId string `json:"task_id"`

	Body *BatchTargets `json:"body,omitempty"`
}

Request Object

func (StopBatchTaskRequest) String added in v0.1.43 

func (o StopBatchTaskRequest) String() string

type StopBatchTaskResponse added in v0.1.43 

type StopBatchTaskResponse struct {

	// 批量操作目标结果集合
	Targets        *[]BatchTargetResult `json:"targets,omitempty"`
	HttpStatusCode int                  `json:"-"`
}

Response Object

func (StopBatchTaskResponse) String added in v0.1.43 

func (o StopBatchTaskResponse) String() string

type Strategy 

type Strategy struct {

	// **参数说明**：规则条件触发的判断策略，默认为pulse。 **取值范围**： - pulse：设备上报的数据满足条件则触发，不判断上一次上报的数据。 - reverse：设备上一次上报的数据不满足条件，本次上报的数据满足条件则触发。
	Trigger *string `json:"trigger,omitempty"`

	// **参数说明**：设备数据的有效时间，单位为秒，设备数据的产生时间以上报数据中的eventTime为基准。
	EventValidTime *int32 `json:"event_valid_time,omitempty"`
}

配置条件处理策略，用于确定规则是否判断上次数据是否满足条件。当rule_type类型为 “DEVICE_LINKAGE”时，为必选参数。默认为pulse触发类型，事件有效性为永久有效

func (Strategy) String 

func (o Strategy) String() string

type TagDeviceRequest 

type TagDeviceRequest struct {

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

	Body *BindTagsDto `json:"body,omitempty"`
}

Request Object

func (TagDeviceRequest) String 

func (o TagDeviceRequest) String() string

type TagDeviceResponse 

type TagDeviceResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (TagDeviceResponse) String 

func (o TagDeviceResponse) String() string

type TagV5Dto 

type TagV5Dto struct {

	// **参数说明**：标签键，在同一资源下标签键唯一。绑定资源时，如果设置的键已存在，则将覆盖之前的标签值。如果设置的键值不存在，则新增标签。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_.-等字符的组合。
	TagKey string `json:"tag_key"`

	// **参数说明**：标签值。 **取值范围**：长度不超过128，只允许中文、字母、数字、以及_.-等字符的组合。
	TagValue *string `json:"tag_value,omitempty"`
}

标签结构体。

func (TagV5Dto) String 

func (o TagV5Dto) String() string

type Task 

type Task struct {

	// 批量任务ID，创建批量任务时由物联网平台分配获得。
	TaskId *string `json:"task_id,omitempty"`

	// 批量任务名称。
	TaskName *string `json:"task_name,omitempty"`

	// 批量任务类型，取值范围：firmwareUpgrade，softwareUpgrade，createDevices，deleteDevices，freezeDevices，unfreezeDevices，createCommands，createAsyncCommands，createMessages，updateDeviceShadows。 - softwareUpgrade: 软件升级任务 - firmwareUpgrade: 固件升级任务 - createDevices: 批量创建设备任务 - deleteDevices: 批量删除设备任务 - freezeDevices: 批量冻结设备任务 - unfreezeDevices: 批量解冻设备任务 - createCommands: 批量创建同步命令任务 - createAsyncCommands: 批量创建异步命令任务 - createMessages: 批量创建消息任务 - updateDeviceShadows: 批量配置设备影子任务 - updateDevices：批量更新设备任务
	TaskType *string `json:"task_type,omitempty"`

	// 执行批量任务的目标，当task_type为firmwareUpgrade，softwareUpgrade，deleteDevices，freezeDevices，unfreezeDevices，createCommands，createAsyncCommands，createMessages，updateDeviceShadows，此处填写device_id列表。
	Targets *[]string `json:"targets,omitempty"`

	// 任务目标筛选参数。Json格式，里面是一个个键值对，（K,V）格式标识筛选targets需要的参数，目前支持的K有group_ids（V填写group_id数组，eg:[\"e495cf17-ff79-4294-8f64-4d367919d665\"]，任务则会筛选出来符合该群组条件的设备作为目标）
	TargetsFilter map[string]interface{} `json:"targets_filter,omitempty"`

	// 执行任务数据文档，Json格式。(当task_type为softwareUpgrade|firmwareUpgrade，也就是软固件升级任务时，Json里面是(K,V)键值对，需要填写key为package_id，value为在平台上传的软固件附件id，id由portal软件库包管理上传并查询获得。当task_type为createCommands，也就是批量创建同步命令任务时，Json里面是命令相关参数，eg：{\"service_id\":\"water\",\"command_name\":\"ON_OFF\",\"paras\":{\"value\":\"ON\"}}，参考[[设备同步命令](https://support.huaweicloud.com/api-iothub/iot_06_v5_0038.html)](tag:hws)[[设备同步命令](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0038.html)](tag:hws_hk))。当task_type为createAsyncCommands，也就是批量创建异步命令任务时，Json里面是命令相关参数，eg：{\"service_id\":\"water\",\"command_name\":\"ON_OFF\",\"paras\":{\"value\":\"ON\"},\"expire_time\":0,\"send_strategy\":\"immediately\"}，参考[[设备异步命令](https://support.huaweicloud.com/api-iothub/iot_06_v5_0040.html)](tag:hws)[[设备异步命令](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0040.html)](tag:hws_hk))。当task_type为updateDeviceShadows，也就是批量配置设备影子任务时，Json里面是命令相关参数，eg：{\"shadow\": [{\"service_id\": \"WaterMeter\",\"desired\": {\"temperature\": \"60\"}}]}，参考[[配置设备影子预期数据](https://support.huaweicloud.com/api-iothub/iot_06_v5_0072.html)](tag:hws)[[配置设备影子预期数据](https://support.huaweicloud.com/intl/zh-cn/api-iothub/iot_06_v5_0072.html)](tag:hws_hk))。
	Document *interface{} `json:"document,omitempty"`

	TaskPolicy *TaskPolicy `json:"task_policy,omitempty"`

	// 批量任务的状态，可选参数，取值范围：Success|Fail|Processing|PartialSuccess|Stopped|Waitting|Initializing|Stopping。 - Initializing: 初始化中。 - Waitting: 等待中。 - Processing: 执行中。 - Success: 成功。 - Fail: 失败。 - PartialSuccess: 部分成功。 - Stopped: 停止。 - Stopping 停止中。
	Status *string `json:"status,omitempty"`

	// 批量任务状态描述(包含主任务失败错误信息)
	StatusDesc *string `json:"status_desc,omitempty"`

	TaskProgress *TaskProgress `json:"task_progress,omitempty"`

	// 批量任务的创建时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`
}

func (Task) String 

func (o Task) String() string

type TaskDetail 

type TaskDetail struct {

	// 执行批量任务的目标。
	Target *string `json:"target,omitempty"`

	// 子任务的执行状态，结果范围：Processing，Success，Fail，Waitting，FailWaitRetry，Stopped。 - Waitting: 等待执行。 - Processing: 执行中。 - Success: 成功。 - Fail: 失败。 - FailWaitRetry: 失败重试。 - Stopped: 已停止。
	Status *string `json:"status,omitempty"`

	// 子任务执行的输出信息。
	Output *string `json:"output,omitempty"`

	Error *ErrorInfo `json:"error,omitempty"`
}

单个子任务详情结构体

func (TaskDetail) String 

func (o TaskDetail) String() string

type TaskPolicy 

type TaskPolicy struct {

	// **参数说明**：批量任务指定执行时间。 **取值范围**：7天内，不传入此参数表示立即执行，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	ScheduleTime *string `json:"schedule_time,omitempty"`

	// **参数说明**：批量任务子任务自动重试次数。 **取值范围**：如果传入retry_interval参数，则需传入该参数，最大支持重试5次。
	RetryCount *int32 `json:"retry_count,omitempty"`

	// **参数说明**：批量任务子任务失败后，自动重试时间间隔，单位：分钟。 **取值范围**：最大1440(24小时)，不传入此参数表示不重试，如果传入retry_count参数则需要传入该参数。
	RetryInterval *int32 `json:"retry_interval,omitempty"`
}

func (TaskPolicy) String 

func (o TaskPolicy) String() string

type TaskProgress 

type TaskProgress struct {

	// 子任务总个数。
	Total *int32 `json:"total,omitempty"`

	// 正在执行的子任务个数。
	Processing *int32 `json:"processing,omitempty"`

	// 执行成功的子任务个数。
	Success *int32 `json:"success,omitempty"`

	// 执行失败的的子任务个数。
	Fail *int32 `json:"fail,omitempty"`

	// 等待执行的子任务个数。
	Waitting *int32 `json:"waitting,omitempty"`

	// 失败等待重试的子任务个数。
	FailWaitRetry *int32 `json:"fail_wait_retry,omitempty"`

	// 停止的子任务个数。
	Stopped *int32 `json:"stopped,omitempty"`

	// 移除的子任务个数。
	Removed *int32 `json:"removed,omitempty"`
}

任务执行状态统计对象，用于统计任务的整体执行情况。

func (TaskProgress) String 

func (o TaskProgress) String() string

type TimeRange 

type TimeRange struct {

	// **参数说明**：规则条件触发的开始时间，格式：HH:mm。
	StartTime string `json:"start_time"`

	// **参数说明**：规则条件触发的结束时间，格式：HH:mm。若结束时间与开始时间一致，则时间为全天。
	EndTime string `json:"end_time"`

	// **参数说明**：星期列表，以逗号分隔。1代表周日，2代表周一，依次类推，默认为每天。星期列表中的日期为开始时间的日期。
	DaysOfWeek *string `json:"days_of_week,omitempty"`
}

规则有效时间段

func (TimeRange) String 

func (o TimeRange) String() string

type UnbindTagsDto 

type UnbindTagsDto struct {

	// **参数说明**：要绑定标签的资源类型。 **取值范围**： - device：设备。
	ResourceType string `json:"resource_type"`

	// **参数说明**：要绑定标签的资源id。例如，资源类型为device，那么对应的资源id就是device_id。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ResourceId string `json:"resource_id"`

	// **参数说明**：指定资源要解绑的标签键列表，标签键列表中各项之间不允许重复，不能填写不存在的标签键值 **取值范围**：标签键长度不超过64，只允许中文、字母、数字、以及_.-等字符的组合。
	TagKeys []string `json:"tag_keys"`
}

创建标签请求结构体。

func (UnbindTagsDto) String 

func (o UnbindTagsDto) String() string

type UnfreezeDeviceRequest 

type UnfreezeDeviceRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`
}

Request Object

func (UnfreezeDeviceRequest) String 

func (o UnfreezeDeviceRequest) String() string

type UnfreezeDeviceResponse 

type UnfreezeDeviceResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UnfreezeDeviceResponse) String 

func (o UnfreezeDeviceResponse) String() string

type UntagDeviceRequest 

type UntagDeviceRequest struct {

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

	Body *UnbindTagsDto `json:"body,omitempty"`
}

Request Object

func (UntagDeviceRequest) String 

func (o UntagDeviceRequest) String() string

type UntagDeviceResponse 

type UntagDeviceResponse struct {
	Body           *string `json:"body,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UntagDeviceResponse) String 

func (o UntagDeviceResponse) String() string

type UpdateActionReq 

type UpdateActionReq struct {

	// **参数说明**：规则动作的类型。 **取值范围**： - HTTP_FORWARDING：HTTP服务消息类型。 - DIS_FORWARDING：转发DIS服务消息类型。 - OBS_FORWARDING：转发OBS服务消息类型。 - AMQP_FORWARDING：转发AMQP服务消息类型。 - DMS_KAFKA_FORWARDING：转发kafka消息类型。[ - ROMA_FORWARDING：转发Roma消息类型。（仅企业版支持） - INFLUXDB_FORWARDING：转发InfluxDB消息类型。（仅标准版和企业版支持） - MYSQL_FORWARDING：转发MySQL消息类型。（仅标准版和企业版支持） - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。（仅标准版和企业版支持） - MRS_KAFKA_FORWARDING：转发MRS_KAFKA消息类型。（仅企业版支持） - DMS_ROCKETMQ_FORWARDING：转发RocketMQ消息类型。（仅标准版和企业版支持）](tag:hws)[ - INFLUXDB_FORWARDING：转发InfluxDB消息类型。 - MYSQL_FORWARDING：转发MySQL消息类型。 - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。](tag:hws_hk)
	Channel *string `json:"channel,omitempty"`

	ChannelDetail *ChannelDetail `json:"channel_detail,omitempty"`
}

修改规则动作请求结构体

func (UpdateActionReq) String 

func (o UpdateActionReq) String() string

type UpdateDesired 

type UpdateDesired struct {

	// **参数说明**：设备的服务ID，在设备关联的产品模型中定义。
	ServiceId string `json:"service_id"`

	// **参数说明**：设备影子期望属性数据，Json格式，里面是一个个键值对，每个键都是产品模型中属性的参数名(property_name)，目前如样例所示只支持一层结构；如果想要删除整个desired可以填写空Object(例如\"desired\":{})，如果想要删除某一个属性期望值可以将属性置位null(例如{\"temperature\":null})
	Desired *interface{} `json:"desired"`

	// **参数说明**：设备影子的版本，携带该参数时平台会校验值必须等于当前影子版本，初始从0开始。
	Version *int64 `json:"version,omitempty"`
}

修改设备影子预期数据结构体。

func (UpdateDesired) String 

func (o UpdateDesired) String() string

type UpdateDesireds 

type UpdateDesireds struct {

	// **参数说明**：设备影子期望值构体。
	Shadow *[]UpdateDesired `json:"shadow,omitempty"`
}

修改设备影子预期数据结构体。

func (UpdateDesireds) String 

func (o UpdateDesireds) String() string

type UpdateDevice 

type UpdateDevice struct {

	// **参数说明**：设备名称。 **取值范围**：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合，建议不少于4个字符。
	DeviceName *string `json:"device_name,omitempty"`

	// **参数说明**：设备的描述信息。 **取值范围**：长度不超过2048，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合
	Description *string `json:"description,omitempty"`

	// **参数说明**：设备扩展信息。用户可以自定义任何想要的扩展信息，修改子设备信息时不会下发给网关。
	ExtensionInfo *interface{} `json:"extension_info,omitempty"`

	AuthInfo *AuthInfoWithoutSecret `json:"auth_info,omitempty"`
}

修改设备信息对象。

func (UpdateDevice) String 

func (o UpdateDevice) String() string

type UpdateDeviceGroupDto 

type UpdateDeviceGroupDto struct {

	// **参数说明**：设备组名称，单个资源空间下不可重复。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。
	Name *string `json:"name,omitempty"`

	// **参数说明**：设备组描述。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。
	Description *string `json:"description,omitempty"`
}

更新设备组请求结构体

func (UpdateDeviceGroupDto) String 

func (o UpdateDeviceGroupDto) String() string

type UpdateDeviceGroupRequest 

type UpdateDeviceGroupRequest struct {

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

	// **参数说明**：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。 **取值范围**：长度不超过36，十六进制字符串和连接符（-）的组合。
	GroupId string `json:"group_id"`

	Body *UpdateDeviceGroupDto `json:"body,omitempty"`
}

Request Object

func (UpdateDeviceGroupRequest) String 

func (o UpdateDeviceGroupRequest) String() string

type UpdateDeviceGroupResponse 

type UpdateDeviceGroupResponse struct {

	// 设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。
	GroupId *string `json:"group_id,omitempty"`

	// 设备组名称，单个资源空间下不可重复。
	Name *string `json:"name,omitempty"`

	// 设备组描述。
	Description *string `json:"description,omitempty"`

	// 父设备组ID，该设备组的父设备组ID。
	SuperGroupId *string `json:"super_group_id,omitempty"`

	// 设备组类型，分为动态设备组和静态设备组两种
	GroupType *string `json:"group_type,omitempty"`

	// 动态设备组规则
	DynamicGroupRule *string `json:"dynamic_group_rule,omitempty"`
	HttpStatusCode   int     `json:"-"`
}

Response Object

func (UpdateDeviceGroupResponse) String 

func (o UpdateDeviceGroupResponse) String() string

type UpdateDeviceRequest 

type UpdateDeviceRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

	Body *UpdateDevice `json:"body,omitempty"`
}

Request Object

func (UpdateDeviceRequest) String 

func (o UpdateDeviceRequest) String() string

type UpdateDeviceResponse 

type UpdateDeviceResponse struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。
	NodeId *string `json:"node_id,omitempty"`

	// 网关ID，用于标识设备所属的父设备，即父设备的设备ID。当设备是直连设备时，gateway_id与设备的device_id一致。当设备是非直连设备时，gateway_id为设备所关联的父设备的device_id。
	GatewayId *string `json:"gateway_id,omitempty"`

	// 设备名称。
	DeviceName *string `json:"device_name,omitempty"`

	// 设备节点类型。 - ENDPOINT：非直连设备。 - GATEWAY：直连设备或网关。 - UNKNOWN：未知。
	NodeType *string `json:"node_type,omitempty"`

	// 设备的描述信息。
	Description *string `json:"description,omitempty"`

	// 设备的固件版本。
	FwVersion *string `json:"fw_version,omitempty"`

	// 设备的软件版本。
	SwVersion *string `json:"sw_version,omitempty"`

	// 设备的sdk信息。
	DeviceSdkVersion *string `json:"device_sdk_version,omitempty"`

	AuthInfo *AuthInfo `json:"auth_info,omitempty"`

	// 设备关联的产品ID，用于唯一标识一个产品模型。
	ProductId *string `json:"product_id,omitempty"`

	// 设备关联的产品名称。
	ProductName *string `json:"product_name,omitempty"`

	// 设备的状态。 - ONLINE：设备在线。 - OFFLINE：设备离线。 - ABNORMAL：设备异常。 - INACTIVE：设备未激活。 - FROZEN：设备冻结。
	Status *string `json:"status,omitempty"`

	// 在物联网平台注册设备的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime *string `json:"create_time,omitempty"`

	// 设备最近一次连接状态(ONLINE:在线，OFFLINE：离线，ABNORMAL：异常)变化时间。格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ，如2015-12-12T12:12:122Z。
	ConnectionStatusUpdateTime *string `json:"connection_status_update_time,omitempty"`

	// 设备激活时间。格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ，如2015-12-12T12:12:122Z。
	ActiveTime *string `json:"active_time,omitempty"`

	// 设备的标签列表。
	Tags *[]TagV5Dto `json:"tags,omitempty"`

	// 设备扩展信息。用户可以自定义任何想要的扩展信息，如果在创建设备时为子设备指定该字段，将会通过MQTT接口“平台通知网关子设备新增“将该信息通知给网关。
	ExtensionInfo  *interface{} `json:"extension_info,omitempty"`
	HttpStatusCode int          `json:"-"`
}

Response Object

func (UpdateDeviceResponse) String 

func (o UpdateDeviceResponse) String() string

type UpdateDeviceShadowDesiredDataRequest 

type UpdateDeviceShadowDesiredDataRequest struct {

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

	// **参数说明**：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

	Body *UpdateDesireds `json:"body,omitempty"`
}

Request Object

func (UpdateDeviceShadowDesiredDataRequest) String 

func (o UpdateDeviceShadowDesiredDataRequest) String() string

type UpdateDeviceShadowDesiredDataResponse 

type UpdateDeviceShadowDesiredDataResponse struct {

	// 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为\"product_id\" + \"_\" + \"node_id\"拼接而成。
	DeviceId *string `json:"device_id,omitempty"`

	// 设备影子数据结构体。
	Shadow         *[]DeviceShadowData `json:"shadow,omitempty"`
	HttpStatusCode int                 `json:"-"`
}

Response Object

func (UpdateDeviceShadowDesiredDataResponse) String 

func (o UpdateDeviceShadowDesiredDataResponse) String() string

type UpdateProduct 

type UpdateProduct struct {

	// **参数说明**：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数，指定要修改的产品属于哪个资源空间；若不携带，则优先修改默认资源空间下产品，如默认资源空间下无对应产品，则按照产品创建时间修改最早创建产品。如果用户存在多资源空间，同时又不想携带该参数，可以联系华为技术支持对用户数据做资源空间合并。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	AppId *string `json:"app_id,omitempty"`

	// **参数说明**：产品名称。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	Name *string `json:"name,omitempty"`

	// **参数说明**：设备类型。 **取值范围**：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	DeviceType *string `json:"device_type,omitempty"`

	// **参数说明**：设备使用的协议类型。注：禁止其他协议类型修改为CoAP。 **取值范围**：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF，OPC-UA，OPC-DA，Other。
	ProtocolType *string `json:"protocol_type,omitempty"`

	// **参数说明**：设备上报数据的格式。 **取值范围**： - json：JSON格式 - binary：二进制码流格式
	DataFormat *string `json:"data_format,omitempty"`

	// **参数说明**：设备的服务能力列表。
	ServiceCapabilities *[]ServiceCapability `json:"service_capabilities,omitempty"`

	// **参数说明**：厂商名称。 **取值范围**：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	ManufacturerName *string `json:"manufacturer_name,omitempty"`

	// **参数说明**：设备所属行业。 **取值范围**：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。
	Industry *string `json:"industry,omitempty"`

	// **参数说明**：产品的描述信息。 **取值范围**：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。/等字符的组合。
	Description *string `json:"description,omitempty"`
}

修改产品信息结构体。

func (UpdateProduct) String 

func (o UpdateProduct) String() string

type UpdateProductRequest 

type UpdateProductRequest struct {

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

	// **参数说明**：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ProductId string `json:"product_id"`

	Body *UpdateProduct `json:"body,omitempty"`
}

Request Object

func (UpdateProductRequest) String 

func (o UpdateProductRequest) String() string

type UpdateProductResponse 

type UpdateProductResponse struct {

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 资源空间名称。
	AppName *string `json:"app_name,omitempty"`

	// 产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。
	ProductId *string `json:"product_id,omitempty"`

	// 产品名称。
	Name *string `json:"name,omitempty"`

	// 设备类型。
	DeviceType *string `json:"device_type,omitempty"`

	// 设备使用的协议类型。取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF， OPC-UA，OPC-DA，Other。
	ProtocolType *string `json:"protocol_type,omitempty"`

	// 设备上报数据的格式，取值范围：json，binary。
	DataFormat *string `json:"data_format,omitempty"`

	// 厂商名称。
	ManufacturerName *string `json:"manufacturer_name,omitempty"`

	// 设备所属行业。
	Industry *string `json:"industry,omitempty"`

	// 产品的描述信息。
	Description *string `json:"description,omitempty"`

	// 设备的服务能力列表。
	ServiceCapabilities *[]ServiceCapability `json:"service_capabilities,omitempty"`

	// 在物联网平台创建产品的时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	CreateTime     *string `json:"create_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UpdateProductResponse) String 

func (o UpdateProductResponse) String() string

type UpdatePropertiesRequest 

type UpdatePropertiesRequest struct {

	// **参数说明**：下发属性的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	DeviceId string `json:"device_id"`

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

	Body *DevicePropertiesRequest `json:"body,omitempty"`
}

Request Object

func (UpdatePropertiesRequest) String 

func (o UpdatePropertiesRequest) String() string

type UpdatePropertiesResponse 

type UpdatePropertiesResponse struct {

	// 设备上报的属性执行结果。Json格式，具体格式需要应用和设备约定。
	Response       *interface{} `json:"response,omitempty"`
	HttpStatusCode int          `json:"-"`
}

Response Object

func (UpdatePropertiesResponse) String 

func (o UpdatePropertiesResponse) String() string

type UpdateRoutingRuleRequest 

type UpdateRoutingRuleRequest struct {

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

	// **参数说明**：规则条件ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	RuleId string `json:"rule_id"`

	Body *UpdateRuleReq `json:"body,omitempty"`
}

Request Object

func (UpdateRoutingRuleRequest) String 

func (o UpdateRoutingRuleRequest) String() string

type UpdateRoutingRuleResponse 

type UpdateRoutingRuleResponse struct {

	// 规则触发条件ID，用于唯一标识一个规则触发条件，在创建规则条件时由物联网平台分配获得。
	RuleId *string `json:"rule_id,omitempty"`

	// 用户自定义的规则名称。
	RuleName *string `json:"rule_name,omitempty"`

	// 用户自定义的规则描述。
	Description *string `json:"description,omitempty"`

	Subject *RoutingRuleSubject `json:"subject,omitempty"`

	// 租户规则的生效范围，取值如下： - GLOBAL：生效范围为租户级 - APP：生效范围为资源空间级。
	AppType *string `json:"app_type,omitempty"`

	// 资源空间ID
	AppId *string `json:"app_id,omitempty"`

	// 用户自定义sql select语句，最大长度2500，该参数仅供标准版和企业版用户使用。
	Select *string `json:"select,omitempty"`

	// 用户自定义sql where语句，最大长度2500，该参数仅供标准版和企业版用户使用。
	Where *string `json:"where,omitempty"`

	// 规则条件的状态是否为激活。
	Active         *bool `json:"active,omitempty"`
	HttpStatusCode int   `json:"-"`
}

Response Object

func (UpdateRoutingRuleResponse) String 

func (o UpdateRoutingRuleResponse) String() string

type UpdateRuleActionRequest 

type UpdateRuleActionRequest struct {

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

	// **参数说明**：规则动作ID。 **取值范围**：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。
	ActionId string `json:"action_id"`

	Body *UpdateActionReq `json:"body,omitempty"`
}

Request Object

func (UpdateRuleActionRequest) String 

func (o UpdateRuleActionRequest) String() string

type UpdateRuleActionResponse 

type UpdateRuleActionResponse struct {

	// 规则动作ID，用于唯一标识一条规则动作，在创建规则动作时由物联网平台分配获得，创建时无需携带，由平台统一分配唯一的action_id。
	ActionId *string `json:"action_id,omitempty"`

	// 规则动作对应的的规则触发条件ID。
	RuleId *string `json:"rule_id,omitempty"`

	// 资源空间ID。
	AppId *string `json:"app_id,omitempty"`

	// 规则动作的类型，取值范围： - HTTP_FORWARDING：HTTP服务消息类型。 - DIS_FORWARDING：转发DIS服务消息类型。 - OBS_FORWARDING：转发OBS服务消息类型。 - AMQP_FORWARDING：转发AMQP服务消息类型。 - DMS_KAFKA_FORWARDING：转发kafka消息类型。 [- ROMA_FORWARDING: 转发Roma消息类型。（仅企业版支持）](tag:hws) - INFLUXDB_FORWARDING：转发InfluxDB消息类型。[（仅标准版和企业版支持）](tag:hws) - MYSQL_FORWARDING：转发MySQL消息类型。[（仅标准版和企业版支持）](tag:hws) - FUNCTIONGRAPH_FORWARDING：转发FunctionGraph消息类型。[（仅标准版和企业版支持）](tag:hws) [- MRS_KAFKA_FORWARDING：转发MRS_KAFKA消息类型。（仅企业版支持）](tag:hws) [- DMS_ROCKETMQ_FORWARDING：转发RocketMQ消息类型。（仅标准版和企业版支持）](tag:hws)
	Channel *string `json:"channel,omitempty"`

	ChannelDetail  *ChannelDetail `json:"channel_detail,omitempty"`
	HttpStatusCode int            `json:"-"`
}

Response Object

func (UpdateRuleActionResponse) String 

func (o UpdateRuleActionResponse) String() string

type UpdateRuleReq 

type UpdateRuleReq struct {

	// **参数说明**：规则名称。 **取值范围**：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合
	RuleName *string `json:"rule_name,omitempty"`

	// **参数说明**：用户自定义的规则描述。
	Description *string `json:"description,omitempty"`

	// **参数说明**：用户自定义sql select语句，最大长度2500，更新sql时，select跟where必须同时传参，如果需要清除该参数的值，输入空字符串，该参数仅供标准版和企业版用户使用。
	Select *string `json:"select,omitempty"`

	// **参数说明**：用户自定义sql where语句，最大长度2500，更新操作时，select跟where必须同时传参，如果需要清除该参数的值，输入空字符串，该参数仅供标准版和企业版用户使用。
	Where *string `json:"where,omitempty"`

	// **参数说明**：修改规则条件的状态是否为激活。
	Active *bool `json:"active,omitempty"`
}

修改规则触发条件请求结构体

func (UpdateRuleReq) String 

func (o UpdateRuleReq) String() string

type UpdateRuleRequest 

type UpdateRuleRequest struct {

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

	// **参数说明**：规则ID，用于唯一标识一条规则，在创建规则时由物联网平台分配获得。 **取值范围**：长度不超过32，只允许字母、数字的组合。
	RuleId string `json:"rule_id"`

	Body *Rule `json:"body,omitempty"`
}

Request Object

func (UpdateRuleRequest) String 

func (o UpdateRuleRequest) String() string

type UpdateRuleResponse 

type UpdateRuleResponse struct {

	// 规则id。
	RuleId *string `json:"rule_id,omitempty"`

	// 规则名称。
	Name *string `json:"name,omitempty"`

	// 规则的描述信息。
	Description *string `json:"description,omitempty"`

	ConditionGroup *ConditionGroup `json:"condition_group,omitempty"`

	// 规则的动作列表，单个规则最多支持设置10个动作。
	Actions *[]RuleAction `json:"actions,omitempty"`

	// 规则的类型 - DEVICE_LINKAGE：云端联动规则。 - DEVICE_SIDE：端侧规则。
	RuleType *string `json:"rule_type,omitempty"`

	// 规则的状态，默认值：active。 - active：激活。 - inactive：未激活。
	Status *string `json:"status,omitempty"`

	// 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的规则归属到哪个资源空间下，否则创建的规则将会归属到[[默认资源空间](https://support.huaweicloud.com/usermanual-iothub/iot_01_0006.html#section0)](tag:hws)[[默认资源空间](https://support.huaweicloud.com/intl/zh-cn/usermanual-iothub/iot_01_0006.html#section0)](tag:hws_hk)下。
	AppId *string `json:"app_id,omitempty"`

	// 归属边缘侧节点设备ID列表。
	EdgeNodeIds *[]string `json:"edge_node_ids,omitempty"`

	// 规则最后更新时间，使用UTC时区，格式：yyyyMMdd'T'HHmmss'Z'。
	LastUpdateTime *string `json:"last_update_time,omitempty"`

	DeviceSide     *DeviceSide `json:"device_side,omitempty"`
	HttpStatusCode int         `json:"-"`
}

Response Object

func (UpdateRuleResponse) String 

func (o UpdateRuleResponse) String() string

type UploadBatchTaskFileRequest added in v0.1.23 

type UploadBatchTaskFileRequest struct {

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

	Body *UploadBatchTaskFileRequestBody `json:"body,omitempty" type:"multipart"`
}

Request Object

func (UploadBatchTaskFileRequest) String added in v0.1.23 

func (o UploadBatchTaskFileRequest) String() string

type UploadBatchTaskFileRequestBody added in v0.1.23 

type UploadBatchTaskFileRequestBody struct {

	// **参数说明**：上传批量任务文件。 **取值范围**：当前仅支持xlsx/xls文件格式，且文件最大行数为30000行。
	File *def.FilePart `json:"file"`
}

func (UploadBatchTaskFileRequestBody) String added in v0.1.23 

func (o UploadBatchTaskFileRequestBody) String() string

func (*UploadBatchTaskFileRequestBody) UnmarshalJSON added in v0.1.23 

func (o *UploadBatchTaskFileRequestBody) UnmarshalJSON(b []byte) error

type UploadBatchTaskFileResponse added in v0.1.23 

type UploadBatchTaskFileResponse struct {

	// 上传的批量任务文件ID，由平台自动生成。
	FileId *string `json:"file_id,omitempty"`

	// 上传的批量任务文件名称。
	FileName *string `json:"file_name,omitempty"`

	// 在物联网平台上传文件的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
	UploadTime     *string `json:"upload_time,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UploadBatchTaskFileResponse) String added in v0.1.23 

func (o UploadBatchTaskFileResponse) String() string

type UserPropDto added in v0.1.6 

type UserPropDto struct {

	// **参数说明**：用户自定义属性键。 **取值范围**：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
	PropKey *string `json:"prop_key,omitempty"`

	// **参数说明**：用户自定义属性值。 **取值范围**：长度不超过128，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。
	PropValue *string `json:"prop_value,omitempty"`
}

用户自定义属性

func (UserPropDto) String added in v0.1.6 

func (o UserPropDto) String() string

type VerifyCertificateDto 

type VerifyCertificateDto struct {

	// 验证证书的内容信息。
	VerifyContent string `json:"verify_content"`
}

验证CA证书结构体。

func (VerifyCertificateDto) String 

func (o VerifyCertificateDto) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.