apis

package
v1.13.0 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2019 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddDeviceRequest 

type AddDeviceRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 设备名称 (Optional) */
	DeviceName *string `json:"deviceName"`

	/* 设备所归属的产品 (Optional) */
	ProductKey *string `json:"productKey"`

	/* 设备型号 (Optional) */
	Model *string `json:"model"`

	/* 厂商 (Optional) */
	Manufacturer *string `json:"manufacturer"`

	/* 设备描述 (Optional) */
	Description *string `json:"description"`
}

func NewAddDeviceRequest 

func NewAddDeviceRequest(
	instanceId string,
	regionId string,
) *AddDeviceRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewAddDeviceRequestWithAllParams 

func NewAddDeviceRequestWithAllParams(
	instanceId string,
	regionId string,
	deviceName *string,
	productKey *string,
	model *string,
	manufacturer *string,
	description *string,
) *AddDeviceRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param deviceName: 设备名称 (Optional) * param productKey: 设备所归属的产品 (Optional) * param model: 设备型号 (Optional) * param manufacturer: 厂商 (Optional) * param description: 设备描述 (Optional)

func NewAddDeviceRequestWithoutParam 

func NewAddDeviceRequestWithoutParam() *AddDeviceRequest

This constructor has better compatible ability when API parameters changed

func (AddDeviceRequest) GetRegionId 

func (r AddDeviceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*AddDeviceRequest) SetDescription 

func (r *AddDeviceRequest) SetDescription(description string)

param description: 设备描述(Optional)

func (*AddDeviceRequest) SetDeviceName 

func (r *AddDeviceRequest) SetDeviceName(deviceName string)

param deviceName: 设备名称(Optional)

func (*AddDeviceRequest) SetInstanceId 

func (r *AddDeviceRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*AddDeviceRequest) SetManufacturer 

func (r *AddDeviceRequest) SetManufacturer(manufacturer string)

param manufacturer: 厂商(Optional)

func (*AddDeviceRequest) SetModel 

func (r *AddDeviceRequest) SetModel(model string)

param model: 设备型号(Optional)

func (*AddDeviceRequest) SetProductKey 

func (r *AddDeviceRequest) SetProductKey(productKey string)

param productKey: 设备所归属的产品(Optional)

func (*AddDeviceRequest) SetRegionId 

func (r *AddDeviceRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

type AddDeviceResponse 

type AddDeviceResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    AddDeviceResult    `json:"result"`
}

type AddDeviceResult 

type AddDeviceResult struct {
	DeviceName string `json:"deviceName"`
	Identifier string `json:"identifier"`
	Secret     string `json:"secret"`
}

type CreateProductRequest 

type CreateProductRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Engine实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 产品名称，名称不可为空，3-30个字符，只支持汉字、英文字母、数字、下划线“_”及中划线“-”，必须以汉字、英文字母及数字开头结尾  */
	ProductName string `json:"productName"`

	/* 节点类型，取值：
	0：设备。设备不能挂载子设备。可以直连物联网平台，也可以作为网关的子设备连接物联网平台
	1：网关。网关可以挂载子设备，具有子设备管理模块，维持子设备的拓扑关系，和将拓扑关系同步到物联网平台
	*/
	ProductType int `json:"productType"`

	/* 产品描述，80字符以内 (Optional) */
	ProductDescription *string `json:"productDescription"`

	/* 物模型模板ID，内部参数，用户不可见，默认为自定义 (Optional) */
	TemplateId *string `json:"templateId"`

	/* 内部标签，内部参数，用户不可见，隐藏标签：hidden:true (Optional) */
	InternalTags *interface{} `json:"internalTags"`
}

func NewCreateProductRequest 

func NewCreateProductRequest(
	regionId string,
	instanceId string,
	productName string,
	productType int,
) *CreateProductRequest
  • param regionId: 地域ID (Required)
  • param instanceId: IoT Engine实例ID信息 (Required)
  • param productName: 产品名称，名称不可为空，3-30个字符，只支持汉字、英文字母、数字、下划线“_”及中划线“-”，必须以汉字、英文字母及数字开头结尾 (Required)
  • param productType: 节点类型，取值：

0：设备。设备不能挂载子设备。可以直连物联网平台，也可以作为网关的子设备连接物联网平台 1：网关。网关可以挂载子设备，具有子设备管理模块，维持子设备的拓扑关系，和将拓扑关系同步到物联网平台 

(Required)
*
* @Deprecated, not compatible when mandatory parameters changed

func NewCreateProductRequestWithAllParams 

func NewCreateProductRequestWithAllParams(
	regionId string,
	instanceId string,
	productName string,
	productType int,
	productDescription *string,
	templateId *string,
	internalTags *interface{},
) *CreateProductRequest
  • param regionId: 地域ID (Required)
  • param instanceId: IoT Engine实例ID信息 (Required)
  • param productName: 产品名称，名称不可为空，3-30个字符，只支持汉字、英文字母、数字、下划线“_”及中划线“-”，必须以汉字、英文字母及数字开头结尾 (Required)
  • param productType: 节点类型，取值：

0：设备。设备不能挂载子设备。可以直连物联网平台，也可以作为网关的子设备连接物联网平台 1：网关。网关可以挂载子设备，具有子设备管理模块，维持子设备的拓扑关系，和将拓扑关系同步到物联网平台 

(Required)
* param productDescription: 产品描述，80字符以内 (Optional)
* param templateId: 物模型模板ID，内部参数，用户不可见，默认为自定义 (Optional)
* param internalTags: 内部标签，内部参数，用户不可见，隐藏标签：hidden:true (Optional)

func NewCreateProductRequestWithoutParam 

func NewCreateProductRequestWithoutParam() *CreateProductRequest

This constructor has better compatible ability when API parameters changed

func (CreateProductRequest) GetRegionId 

func (r CreateProductRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateProductRequest) SetInstanceId 

func (r *CreateProductRequest) SetInstanceId(instanceId string)

param instanceId: IoT Engine实例ID信息(Required)

func (*CreateProductRequest) SetInternalTags added in v1.13.0 

func (r *CreateProductRequest) SetInternalTags(internalTags interface{})

param internalTags: 内部标签，内部参数，用户不可见，隐藏标签：hidden:true(Optional)

func (*CreateProductRequest) SetProductDescription 

func (r *CreateProductRequest) SetProductDescription(productDescription string)

param productDescription: 产品描述，80字符以内(Optional)

func (*CreateProductRequest) SetProductName 

func (r *CreateProductRequest) SetProductName(productName string)

param productName: 产品名称，名称不可为空，3-30个字符，只支持汉字、英文字母、数字、下划线“_”及中划线“-”，必须以汉字、英文字母及数字开头结尾(Required)

func (*CreateProductRequest) SetProductType 

func (r *CreateProductRequest) SetProductType(productType int)
param productType: 节点类型，取值：

0：设备。设备不能挂载子设备。可以直连物联网平台，也可以作为网关的子设备连接物联网平台 1：网关。网关可以挂载子设备，具有子设备管理模块，维持子设备的拓扑关系，和将拓扑关系同步到物联网平台 (Required)

func (*CreateProductRequest) SetRegionId 

func (r *CreateProductRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

func (*CreateProductRequest) SetTemplateId 

func (r *CreateProductRequest) SetTemplateId(templateId string)

param templateId: 物模型模板ID，内部参数，用户不可见，默认为自定义(Optional)

type CreateProductResponse 

type CreateProductResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    CreateProductResult `json:"result"`
}

type CreateProductResult 

type CreateProductResult struct {
	ProductKey string `json:"productKey"`
}

type CreateProductTopicRequest added in v1.13.0 

type CreateProductTopicRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Engine实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`

	/* 自定义类目名称, /user/{productKey}/{identifier}/topicShortName  */
	TopicShortName string `json:"topicShortName"`

	/* 设备对该Topic类的操作权限，取值
	sub:订阅
	pub:发布
	*/
	TopicOperation string `json:"topicOperation"`

	/* 描述, 0-50个字符 (Optional) */
	TopicDescription *string `json:"topicDescription"`
}

func NewCreateProductTopicRequest added in v1.13.0 

func NewCreateProductTopicRequest(
	regionId string,
	instanceId string,
	productKey string,
	topicShortName string,
	topicOperation string,
) *CreateProductTopicRequest
  • param regionId: 地域ID (Required)
  • param instanceId: IoT Engine实例ID信息 (Required)
  • param productKey: 产品Key (Required)
  • param topicShortName: 自定义类目名称, /user/{productKey}/{identifier}/topicShortName (Required)
  • param topicOperation: 设备对该Topic类的操作权限，取值

sub:订阅 pub:发布 

(Required)
*
* @Deprecated, not compatible when mandatory parameters changed

func NewCreateProductTopicRequestWithAllParams added in v1.13.0 

func NewCreateProductTopicRequestWithAllParams(
	regionId string,
	instanceId string,
	productKey string,
	topicShortName string,
	topicOperation string,
	topicDescription *string,
) *CreateProductTopicRequest
  • param regionId: 地域ID (Required)
  • param instanceId: IoT Engine实例ID信息 (Required)
  • param productKey: 产品Key (Required)
  • param topicShortName: 自定义类目名称, /user/{productKey}/{identifier}/topicShortName (Required)
  • param topicOperation: 设备对该Topic类的操作权限，取值

sub:订阅 pub:发布 

(Required)
* param topicDescription: 描述, 0-50个字符 (Optional)

func NewCreateProductTopicRequestWithoutParam added in v1.13.0 

func NewCreateProductTopicRequestWithoutParam() *CreateProductTopicRequest

This constructor has better compatible ability when API parameters changed

func (CreateProductTopicRequest) GetRegionId added in v1.13.0 

func (r CreateProductTopicRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateProductTopicRequest) SetInstanceId added in v1.13.0 

func (r *CreateProductTopicRequest) SetInstanceId(instanceId string)

param instanceId: IoT Engine实例ID信息(Required)

func (*CreateProductTopicRequest) SetProductKey added in v1.13.0 

func (r *CreateProductTopicRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*CreateProductTopicRequest) SetRegionId added in v1.13.0 

func (r *CreateProductTopicRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

func (*CreateProductTopicRequest) SetTopicDescription added in v1.13.0 

func (r *CreateProductTopicRequest) SetTopicDescription(topicDescription string)

param topicDescription: 描述, 0-50个字符(Optional)

func (*CreateProductTopicRequest) SetTopicOperation added in v1.13.0 

func (r *CreateProductTopicRequest) SetTopicOperation(topicOperation string)
param topicOperation: 设备对该Topic类的操作权限，取值

sub:订阅 pub:发布 (Required)

func (*CreateProductTopicRequest) SetTopicShortName added in v1.13.0 

func (r *CreateProductTopicRequest) SetTopicShortName(topicShortName string)

param topicShortName: 自定义类目名称, /user/{productKey}/{identifier}/topicShortName(Required)

type CreateProductTopicResponse added in v1.13.0 

type CreateProductTopicResponse struct {
	RequestID string                   `json:"requestId"`
	Error     core.ErrorResponse       `json:"error"`
	Result    CreateProductTopicResult `json:"result"`
}

type CreateProductTopicResult added in v1.13.0 

type CreateProductTopicResult struct {
	TopicId string `json:"topicId"`
}

type DeleteProductRequest 

type DeleteProductRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Engine实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`
}

func NewDeleteProductRequest 

func NewDeleteProductRequest(
	regionId string,
	instanceId string,
	productKey string,
) *DeleteProductRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Engine实例ID信息 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteProductRequestWithAllParams 

func NewDeleteProductRequestWithAllParams(
	regionId string,
	instanceId string,
	productKey string,
) *DeleteProductRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Engine实例ID信息 (Required) * param productKey: 产品Key (Required)

func NewDeleteProductRequestWithoutParam 

func NewDeleteProductRequestWithoutParam() *DeleteProductRequest

This constructor has better compatible ability when API parameters changed

func (DeleteProductRequest) GetRegionId 

func (r DeleteProductRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteProductRequest) SetInstanceId 

func (r *DeleteProductRequest) SetInstanceId(instanceId string)

param instanceId: IoT Engine实例ID信息(Required)

func (*DeleteProductRequest) SetProductKey 

func (r *DeleteProductRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*DeleteProductRequest) SetRegionId 

func (r *DeleteProductRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type DeleteProductResponse 

type DeleteProductResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DeleteProductResult `json:"result"`
}

type DeleteProductResult 

type DeleteProductResult struct {
}

type DescribeProductRequest 

type DescribeProductRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Engine实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`
}

func NewDescribeProductRequest 

func NewDescribeProductRequest(
	regionId string,
	instanceId string,
	productKey string,
) *DescribeProductRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Engine实例ID信息 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeProductRequestWithAllParams 

func NewDescribeProductRequestWithAllParams(
	regionId string,
	instanceId string,
	productKey string,
) *DescribeProductRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Engine实例ID信息 (Required) * param productKey: 产品Key (Required)

func NewDescribeProductRequestWithoutParam 

func NewDescribeProductRequestWithoutParam() *DescribeProductRequest

This constructor has better compatible ability when API parameters changed

func (DescribeProductRequest) GetRegionId 

func (r DescribeProductRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeProductRequest) SetInstanceId 

func (r *DescribeProductRequest) SetInstanceId(instanceId string)

param instanceId: IoT Engine实例ID信息(Required)

func (*DescribeProductRequest) SetProductKey 

func (r *DescribeProductRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*DescribeProductRequest) SetRegionId 

func (r *DescribeProductRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type DescribeProductResponse 

type DescribeProductResponse struct {
	RequestID string                `json:"requestId"`
	Error     core.ErrorResponse    `json:"error"`
	Result    DescribeProductResult `json:"result"`
}

type DescribeProductResult 

type DescribeProductResult struct {
	ProductName        string `json:"productName"`
	ProductType        int    `json:"productType"`
	ProductKey         string `json:"productKey"`
	ProductSecret      string `json:"productSecret"`
	CreatedTime        int64  `json:"createdTime"`
	DeviceCount        int    `json:"deviceCount"`
	DynamicRegister    int    `json:"dynamicRegister"`
	ProductDescription string `json:"productDescription"`
	TemplateName       string `json:"templateName"`
}

type DescribeThingShadowRequest 

type DescribeThingShadowRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 设备唯一标识  */
	Identifier string `json:"identifier"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`
}

func NewDescribeThingShadowRequest 

func NewDescribeThingShadowRequest(
	instanceId string,
	regionId string,
	identifier string,
	productKey string,
) *DescribeThingShadowRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param identifier: 设备唯一标识 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeThingShadowRequestWithAllParams 

func NewDescribeThingShadowRequestWithAllParams(
	instanceId string,
	regionId string,
	identifier string,
	productKey string,
) *DescribeThingShadowRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param identifier: 设备唯一标识 (Required) * param productKey: 产品Key (Required)

func NewDescribeThingShadowRequestWithoutParam 

func NewDescribeThingShadowRequestWithoutParam() *DescribeThingShadowRequest

This constructor has better compatible ability when API parameters changed

func (DescribeThingShadowRequest) GetRegionId 

func (r DescribeThingShadowRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeThingShadowRequest) SetIdentifier 

func (r *DescribeThingShadowRequest) SetIdentifier(identifier string)

param identifier: 设备唯一标识(Required)

func (*DescribeThingShadowRequest) SetInstanceId 

func (r *DescribeThingShadowRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*DescribeThingShadowRequest) SetProductKey 

func (r *DescribeThingShadowRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*DescribeThingShadowRequest) SetRegionId 

func (r *DescribeThingShadowRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

type DescribeThingShadowResponse 

type DescribeThingShadowResponse struct {
	RequestID string                    `json:"requestId"`
	Error     core.ErrorResponse        `json:"error"`
	Result    DescribeThingShadowResult `json:"result"`
}

type DescribeThingShadowResult 

type DescribeThingShadowResult struct {
	State     interface{} `json:"state"`
	Metadata  interface{} `json:"metadata"`
	Version   int         `json:"version"`
	Timestamp int64       `json:"timestamp"`
}

type ExportThingModelRequest 

type ExportThingModelRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Hub实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`
}

func NewExportThingModelRequest 

func NewExportThingModelRequest(
	regionId string,
	instanceId string,
	productKey string,
) *ExportThingModelRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Hub实例ID信息 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewExportThingModelRequestWithAllParams 

func NewExportThingModelRequestWithAllParams(
	regionId string,
	instanceId string,
	productKey string,
) *ExportThingModelRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Hub实例ID信息 (Required) * param productKey: 产品Key (Required)

func NewExportThingModelRequestWithoutParam 

func NewExportThingModelRequestWithoutParam() *ExportThingModelRequest

This constructor has better compatible ability when API parameters changed

func (ExportThingModelRequest) GetRegionId 

func (r ExportThingModelRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ExportThingModelRequest) SetInstanceId 

func (r *ExportThingModelRequest) SetInstanceId(instanceId string)

param instanceId: IoT Hub实例ID信息(Required)

func (*ExportThingModelRequest) SetProductKey 

func (r *ExportThingModelRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*ExportThingModelRequest) SetRegionId 

func (r *ExportThingModelRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type ExportThingModelResponse 

type ExportThingModelResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    ExportThingModelResult `json:"result"`
}

type ExportThingModelResult 

type ExportThingModelResult struct {
	ThingModel interface{} `json:"thingModel"`
}

type ImportThingModelRequest 

type ImportThingModelRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Hub实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`

	/* 物模型JSON  */
	ThingModel interface{} `json:"thingModel"`
}

func NewImportThingModelRequest 

func NewImportThingModelRequest(
	regionId string,
	instanceId string,
	productKey string,
	thingModel interface{},
) *ImportThingModelRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Hub实例ID信息 (Required) * param productKey: 产品Key (Required) * param thingModel: 物模型JSON (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewImportThingModelRequestWithAllParams 

func NewImportThingModelRequestWithAllParams(
	regionId string,
	instanceId string,
	productKey string,
	thingModel interface{},
) *ImportThingModelRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Hub实例ID信息 (Required) * param productKey: 产品Key (Required) * param thingModel: 物模型JSON (Required)

func NewImportThingModelRequestWithoutParam 

func NewImportThingModelRequestWithoutParam() *ImportThingModelRequest

This constructor has better compatible ability when API parameters changed

func (ImportThingModelRequest) GetRegionId 

func (r ImportThingModelRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ImportThingModelRequest) SetInstanceId 

func (r *ImportThingModelRequest) SetInstanceId(instanceId string)

param instanceId: IoT Hub实例ID信息(Required)

func (*ImportThingModelRequest) SetProductKey 

func (r *ImportThingModelRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*ImportThingModelRequest) SetRegionId 

func (r *ImportThingModelRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

func (*ImportThingModelRequest) SetThingModel 

func (r *ImportThingModelRequest) SetThingModel(thingModel interface{})

param thingModel: 物模型JSON(Required)

type ImportThingModelResponse 

type ImportThingModelResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    ImportThingModelResult `json:"result"`
}

type ImportThingModelResult 

type ImportThingModelResult struct {
}

type InvokeThingServiceRequest 

type InvokeThingServiceRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 设备唯一标识  */
	Identifier string `json:"identifier"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`

	/* 服务名称  */
	Name string `json:"name"`

	/* 输入参数,object的key为参数名称，value为参数值 (Optional) */
	Input *interface{} `json:"input"`

	/* 回调spring的bean的名称 (Optional) */
	CallbackBeanName *string `json:"callbackBeanName"`
}

func NewInvokeThingServiceRequest 

func NewInvokeThingServiceRequest(
	instanceId string,
	regionId string,
	identifier string,
	productKey string,
	name string,
) *InvokeThingServiceRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param identifier: 设备唯一标识 (Required) * param productKey: 产品Key (Required) * param name: 服务名称 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewInvokeThingServiceRequestWithAllParams 

func NewInvokeThingServiceRequestWithAllParams(
	instanceId string,
	regionId string,
	identifier string,
	productKey string,
	name string,
	input *interface{},
	callbackBeanName *string,
) *InvokeThingServiceRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param identifier: 设备唯一标识 (Required) * param productKey: 产品Key (Required) * param name: 服务名称 (Required) * param input: 输入参数,object的key为参数名称，value为参数值 (Optional) * param callbackBeanName: 回调spring的bean的名称 (Optional)

func NewInvokeThingServiceRequestWithoutParam 

func NewInvokeThingServiceRequestWithoutParam() *InvokeThingServiceRequest

This constructor has better compatible ability when API parameters changed

func (InvokeThingServiceRequest) GetRegionId 

func (r InvokeThingServiceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*InvokeThingServiceRequest) SetCallbackBeanName added in v1.13.0 

func (r *InvokeThingServiceRequest) SetCallbackBeanName(callbackBeanName string)

param callbackBeanName: 回调spring的bean的名称(Optional)

func (*InvokeThingServiceRequest) SetIdentifier 

func (r *InvokeThingServiceRequest) SetIdentifier(identifier string)

param identifier: 设备唯一标识(Required)

func (*InvokeThingServiceRequest) SetInput 

func (r *InvokeThingServiceRequest) SetInput(input interface{})

param input: 输入参数,object的key为参数名称，value为参数值(Optional)

func (*InvokeThingServiceRequest) SetInstanceId 

func (r *InvokeThingServiceRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*InvokeThingServiceRequest) SetName 

func (r *InvokeThingServiceRequest) SetName(name string)

param name: 服务名称(Required)

func (*InvokeThingServiceRequest) SetProductKey 

func (r *InvokeThingServiceRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*InvokeThingServiceRequest) SetRegionId 

func (r *InvokeThingServiceRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

type InvokeThingServiceResponse 

type InvokeThingServiceResponse struct {
	RequestID string                   `json:"requestId"`
	Error     core.ErrorResponse       `json:"error"`
	Result    InvokeThingServiceResult `json:"result"`
}

type InvokeThingServiceResult 

type InvokeThingServiceResult struct {
	MsgId string `json:"msgId"`
}

type InvokeThingTopicRequest added in v1.13.0 

type InvokeThingTopicRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 设备唯一标识  */
	Identifier string `json:"identifier"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`

	/* Topic如/user/{productKey}/{identifier}/topicShortName
	不支持系统Topic
	*/
	TopicShortName string `json:"topicShortName"`

	/* 要发送的消息主体  */
	TopicMessage string `json:"topicMessage"`
}

func NewInvokeThingTopicRequest added in v1.13.0 

func NewInvokeThingTopicRequest(
	instanceId string,
	regionId string,
	identifier string,
	productKey string,
	topicShortName string,
	topicMessage string,
) *InvokeThingTopicRequest
  • param instanceId: 设备归属的实例ID (Required)
  • param regionId: 设备归属的实例所在区域 (Required)
  • param identifier: 设备唯一标识 (Required)
  • param productKey: 产品Key (Required)
  • param topicShortName: Topic如/user/{productKey}/{identifier}/topicShortName

不支持系统Topic 

(Required)
* param topicMessage: 要发送的消息主体 (Required)
*
* @Deprecated, not compatible when mandatory parameters changed

func NewInvokeThingTopicRequestWithAllParams added in v1.13.0 

func NewInvokeThingTopicRequestWithAllParams(
	instanceId string,
	regionId string,
	identifier string,
	productKey string,
	topicShortName string,
	topicMessage string,
) *InvokeThingTopicRequest
  • param instanceId: 设备归属的实例ID (Required)
  • param regionId: 设备归属的实例所在区域 (Required)
  • param identifier: 设备唯一标识 (Required)
  • param productKey: 产品Key (Required)
  • param topicShortName: Topic如/user/{productKey}/{identifier}/topicShortName

不支持系统Topic 

(Required)
* param topicMessage: 要发送的消息主体 (Required)

func NewInvokeThingTopicRequestWithoutParam added in v1.13.0 

func NewInvokeThingTopicRequestWithoutParam() *InvokeThingTopicRequest

This constructor has better compatible ability when API parameters changed

func (InvokeThingTopicRequest) GetRegionId added in v1.13.0 

func (r InvokeThingTopicRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*InvokeThingTopicRequest) SetIdentifier added in v1.13.0 

func (r *InvokeThingTopicRequest) SetIdentifier(identifier string)

param identifier: 设备唯一标识(Required)

func (*InvokeThingTopicRequest) SetInstanceId added in v1.13.0 

func (r *InvokeThingTopicRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*InvokeThingTopicRequest) SetProductKey added in v1.13.0 

func (r *InvokeThingTopicRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*InvokeThingTopicRequest) SetRegionId added in v1.13.0 

func (r *InvokeThingTopicRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

func (*InvokeThingTopicRequest) SetTopicMessage added in v1.13.0 

func (r *InvokeThingTopicRequest) SetTopicMessage(topicMessage string)

param topicMessage: 要发送的消息主体(Required)

func (*InvokeThingTopicRequest) SetTopicShortName added in v1.13.0 

func (r *InvokeThingTopicRequest) SetTopicShortName(topicShortName string)
param topicShortName: Topic如/user/{productKey}/{identifier}/topicShortName

不支持系统Topic (Required)

type InvokeThingTopicResponse added in v1.13.0 

type InvokeThingTopicResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    InvokeThingTopicResult `json:"result"`
}

type InvokeThingTopicResult added in v1.13.0 

type InvokeThingTopicResult struct {
	MsgId string `json:"msgId"`
}

type ListProductAbilitiesRequest 

type ListProductAbilitiesRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Hub实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`

	/* 页码, 默认为1, 取值范围：[1,∞) (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小，默认为10，取值范围：[10,100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* abilityName-功能名称，精确匹配
	abilityType-功能类型，精确匹配
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewListProductAbilitiesRequest 

func NewListProductAbilitiesRequest(
	regionId string,
	instanceId string,
	productKey string,
) *ListProductAbilitiesRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Hub实例ID信息 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewListProductAbilitiesRequestWithAllParams 

func NewListProductAbilitiesRequestWithAllParams(
	regionId string,
	instanceId string,
	productKey string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
) *ListProductAbilitiesRequest
  • param regionId: 地域ID (Required)
  • param instanceId: IoT Hub实例ID信息 (Required)
  • param productKey: 产品Key (Required)
  • param pageNumber: 页码, 默认为1, 取值范围：[1,∞) (Optional)
  • param pageSize: 分页大小，默认为10，取值范围：[10,100] (Optional)
  • param filters: abilityName-功能名称，精确匹配

abilityType-功能类型，精确匹配 

(Optional)

func NewListProductAbilitiesRequestWithoutParam 

func NewListProductAbilitiesRequestWithoutParam() *ListProductAbilitiesRequest

This constructor has better compatible ability when API parameters changed

func (ListProductAbilitiesRequest) GetRegionId 

func (r ListProductAbilitiesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ListProductAbilitiesRequest) SetFilters 

func (r *ListProductAbilitiesRequest) SetFilters(filters []common.Filter)
param filters: abilityName-功能名称，精确匹配

abilityType-功能类型，精确匹配 (Optional)

func (*ListProductAbilitiesRequest) SetInstanceId 

func (r *ListProductAbilitiesRequest) SetInstanceId(instanceId string)

param instanceId: IoT Hub实例ID信息(Required)

func (*ListProductAbilitiesRequest) SetPageNumber 

func (r *ListProductAbilitiesRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码, 默认为1, 取值范围：[1,∞)(Optional)

func (*ListProductAbilitiesRequest) SetPageSize 

func (r *ListProductAbilitiesRequest) SetPageSize(pageSize int)

param pageSize: 分页大小，默认为10，取值范围：[10,100](Optional)

func (*ListProductAbilitiesRequest) SetProductKey 

func (r *ListProductAbilitiesRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*ListProductAbilitiesRequest) SetRegionId 

func (r *ListProductAbilitiesRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type ListProductAbilitiesResponse 

type ListProductAbilitiesResponse struct {
	RequestID string                     `json:"requestId"`
	Error     core.ErrorResponse         `json:"error"`
	Result    ListProductAbilitiesResult `json:"result"`
}

type ListProductAbilitiesResult 

type ListProductAbilitiesResult struct {
	Page      iotcore.PageinfoVO       `json:"page"`
	Abilities []iotcore.ProductAbility `json:"abilities"`
}

type ListProductsRequest 

type ListProductsRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Engine实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 页码, 默认为1, 取值范围：[1,∞) (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小，默认为10，取值范围：[10,100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* productName-产品名称，精确匹配，支持单个
	productKey-产品key，精确匹配，支持单个
	productType-产品类型，精确匹配，支持单个
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewListProductsRequest 

func NewListProductsRequest(
	regionId string,
	instanceId string,
) *ListProductsRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Engine实例ID信息 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewListProductsRequestWithAllParams 

func NewListProductsRequestWithAllParams(
	regionId string,
	instanceId string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
) *ListProductsRequest
  • param regionId: 地域ID (Required)
  • param instanceId: IoT Engine实例ID信息 (Required)
  • param pageNumber: 页码, 默认为1, 取值范围：[1,∞) (Optional)
  • param pageSize: 分页大小，默认为10，取值范围：[10,100] (Optional)
  • param filters: productName-产品名称，精确匹配，支持单个

productKey-产品key，精确匹配，支持单个 productType-产品类型，精确匹配，支持单个 

(Optional)

func NewListProductsRequestWithoutParam 

func NewListProductsRequestWithoutParam() *ListProductsRequest

This constructor has better compatible ability when API parameters changed

func (ListProductsRequest) GetRegionId 

func (r ListProductsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ListProductsRequest) SetFilters 

func (r *ListProductsRequest) SetFilters(filters []common.Filter)
param filters: productName-产品名称，精确匹配，支持单个

productKey-产品key，精确匹配，支持单个 productType-产品类型，精确匹配，支持单个 (Optional)

func (*ListProductsRequest) SetInstanceId 

func (r *ListProductsRequest) SetInstanceId(instanceId string)

param instanceId: IoT Engine实例ID信息(Required)

func (*ListProductsRequest) SetPageNumber 

func (r *ListProductsRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码, 默认为1, 取值范围：[1,∞)(Optional)

func (*ListProductsRequest) SetPageSize 

func (r *ListProductsRequest) SetPageSize(pageSize int)

param pageSize: 分页大小，默认为10，取值范围：[10,100](Optional)

func (*ListProductsRequest) SetRegionId 

func (r *ListProductsRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type ListProductsResponse 

type ListProductsResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ListProductsResult `json:"result"`
}

type ListProductsResult 

type ListProductsResult struct {
	Page     iotcore.PageinfoVO `json:"page"`
	Products []iotcore.Product  `json:"products"`
}

type QueryDeviceDetailRequest 

type QueryDeviceDetailRequest struct {
	core.JDCloudRequest

	/* 设备名称  */
	DeviceName string `json:"deviceName"`

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`
}

func NewQueryDeviceDetailRequest 

func NewQueryDeviceDetailRequest(
	deviceName string,
	instanceId string,
	regionId string,
	productKey string,
) *QueryDeviceDetailRequest

* param deviceName: 设备名称 (Required) * param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewQueryDeviceDetailRequestWithAllParams 

func NewQueryDeviceDetailRequestWithAllParams(
	deviceName string,
	instanceId string,
	regionId string,
	productKey string,
) *QueryDeviceDetailRequest

* param deviceName: 设备名称 (Required) * param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param productKey: 产品Key (Required)

func NewQueryDeviceDetailRequestWithoutParam 

func NewQueryDeviceDetailRequestWithoutParam() *QueryDeviceDetailRequest

This constructor has better compatible ability when API parameters changed

func (QueryDeviceDetailRequest) GetRegionId 

func (r QueryDeviceDetailRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*QueryDeviceDetailRequest) SetDeviceName 

func (r *QueryDeviceDetailRequest) SetDeviceName(deviceName string)

param deviceName: 设备名称(Required)

func (*QueryDeviceDetailRequest) SetInstanceId 

func (r *QueryDeviceDetailRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*QueryDeviceDetailRequest) SetProductKey 

func (r *QueryDeviceDetailRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*QueryDeviceDetailRequest) SetRegionId 

func (r *QueryDeviceDetailRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

type QueryDeviceDetailResponse 

type QueryDeviceDetailResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    QueryDeviceDetailResult `json:"result"`
}

type QueryDeviceDetailResult 

type QueryDeviceDetailResult struct {
	DeviceId          string `json:"deviceId"`
	DeviceName        string `json:"deviceName"`
	ParentId          string `json:"parentId"`
	DeviceType        string `json:"deviceType"`
	Status            int    `json:"status"`
	ProductKey        string `json:"productKey"`
	Identifier        string `json:"identifier"`
	Secret            string `json:"secret"`
	Description       string `json:"description"`
	ActivatedTime     int64  `json:"activatedTime"`
	LastConnectedTime int64  `json:"lastConnectedTime"`
	CreatedTime       int64  `json:"createdTime"`
	UpdatedTime       int64  `json:"updatedTime"`
	ProductName       string `json:"productName"`
	Model             string `json:"model"`
	Manufacturer      string `json:"manufacturer"`
	DynamicRegister   int    `json:"dynamicRegister"`
}

type QueryDevicePageRequest 

type QueryDevicePageRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 设备名称，模糊匹配 (Optional) */
	DeviceName *string `json:"deviceName"`

	/* 设备状态 0-未激活，1-激活离线，2-激活在线 (Optional) */
	Status *int `json:"status"`

	/* 设备所归属的产品Key (Optional) */
	ProductKey *string `json:"productKey"`

	/* 设备类型，同产品类型，0-设备，1-网关 (Optional) */
	DeviceType *int `json:"deviceType"`

	/* 当前页数 (Optional) */
	NowPage *int `json:"nowPage"`

	/* 每页的数据条数 (Optional) */
	PageSize *int `json:"pageSize"`

	/* 排序关键字--name,type,productKey,status--最多支持一个字段 (Optional) */
	Order *string `json:"order"`

	/* 顺序，升序降序--asc,desc (Optional) */
	Direction *string `json:"direction"`

	/* 父设备Id (Optional) */
	ParentId *string `json:"parentId"`
}

func NewQueryDevicePageRequest 

func NewQueryDevicePageRequest(
	instanceId string,
	regionId string,
) *QueryDevicePageRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewQueryDevicePageRequestWithAllParams 

func NewQueryDevicePageRequestWithAllParams(
	instanceId string,
	regionId string,
	deviceName *string,
	status *int,
	productKey *string,
	deviceType *int,
	nowPage *int,
	pageSize *int,
	order *string,
	direction *string,
	parentId *string,
) *QueryDevicePageRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param deviceName: 设备名称，模糊匹配 (Optional) * param status: 设备状态 0-未激活，1-激活离线，2-激活在线 (Optional) * param productKey: 设备所归属的产品Key (Optional) * param deviceType: 设备类型，同产品类型，0-设备，1-网关 (Optional) * param nowPage: 当前页数 (Optional) * param pageSize: 每页的数据条数 (Optional) * param order: 排序关键字--name,type,productKey,status--最多支持一个字段 (Optional) * param direction: 顺序，升序降序--asc,desc (Optional) * param parentId: 父设备Id (Optional)

func NewQueryDevicePageRequestWithoutParam 

func NewQueryDevicePageRequestWithoutParam() *QueryDevicePageRequest

This constructor has better compatible ability when API parameters changed

func (QueryDevicePageRequest) GetRegionId 

func (r QueryDevicePageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*QueryDevicePageRequest) SetDeviceName 

func (r *QueryDevicePageRequest) SetDeviceName(deviceName string)

param deviceName: 设备名称，模糊匹配(Optional)

func (*QueryDevicePageRequest) SetDeviceType 

func (r *QueryDevicePageRequest) SetDeviceType(deviceType int)

param deviceType: 设备类型，同产品类型，0-设备，1-网关(Optional)

func (*QueryDevicePageRequest) SetDirection 

func (r *QueryDevicePageRequest) SetDirection(direction string)

param direction: 顺序，升序降序--asc,desc(Optional)

func (*QueryDevicePageRequest) SetInstanceId 

func (r *QueryDevicePageRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*QueryDevicePageRequest) SetNowPage 

func (r *QueryDevicePageRequest) SetNowPage(nowPage int)

param nowPage: 当前页数(Optional)

func (*QueryDevicePageRequest) SetOrder 

func (r *QueryDevicePageRequest) SetOrder(order string)

param order: 排序关键字--name,type,productKey,status--最多支持一个字段(Optional)

func (*QueryDevicePageRequest) SetPageSize 

func (r *QueryDevicePageRequest) SetPageSize(pageSize int)

param pageSize: 每页的数据条数(Optional)

func (*QueryDevicePageRequest) SetParentId 

func (r *QueryDevicePageRequest) SetParentId(parentId string)

param parentId: 父设备Id(Optional)

func (*QueryDevicePageRequest) SetProductKey 

func (r *QueryDevicePageRequest) SetProductKey(productKey string)

param productKey: 设备所归属的产品Key(Optional)

func (*QueryDevicePageRequest) SetRegionId 

func (r *QueryDevicePageRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

func (*QueryDevicePageRequest) SetStatus 

func (r *QueryDevicePageRequest) SetStatus(status int)

param status: 设备状态 0-未激活，1-激活离线，2-激活在线(Optional)

type QueryDevicePageResponse 

type QueryDevicePageResponse struct {
	RequestID string                `json:"requestId"`
	Error     core.ErrorResponse    `json:"error"`
	Result    QueryDevicePageResult `json:"result"`
}

type QueryDevicePageResult 

type QueryDevicePageResult struct {
	PageSize  int                `json:"pageSize"`
	NowPage   int                `json:"nowPage"`
	TotalSize int                `json:"totalSize"`
	TotalPage int                `json:"totalPage"`
	Data      []iotcore.DeviceVO `json:"data"`
}

type RemoveDeviceRequest 

type RemoveDeviceRequest struct {
	core.JDCloudRequest

	/* 设备名称  */
	DeviceName string `json:"deviceName"`

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`
}

func NewRemoveDeviceRequest 

func NewRemoveDeviceRequest(
	deviceName string,
	instanceId string,
	regionId string,
	productKey string,
) *RemoveDeviceRequest

* param deviceName: 设备名称 (Required) * param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewRemoveDeviceRequestWithAllParams 

func NewRemoveDeviceRequestWithAllParams(
	deviceName string,
	instanceId string,
	regionId string,
	productKey string,
) *RemoveDeviceRequest

* param deviceName: 设备名称 (Required) * param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param productKey: 产品Key (Required)

func NewRemoveDeviceRequestWithoutParam 

func NewRemoveDeviceRequestWithoutParam() *RemoveDeviceRequest

This constructor has better compatible ability when API parameters changed

func (RemoveDeviceRequest) GetRegionId 

func (r RemoveDeviceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RemoveDeviceRequest) SetDeviceName 

func (r *RemoveDeviceRequest) SetDeviceName(deviceName string)

param deviceName: 设备名称(Required)

func (*RemoveDeviceRequest) SetInstanceId 

func (r *RemoveDeviceRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*RemoveDeviceRequest) SetProductKey 

func (r *RemoveDeviceRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*RemoveDeviceRequest) SetRegionId 

func (r *RemoveDeviceRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

type RemoveDeviceResponse 

type RemoveDeviceResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    RemoveDeviceResult `json:"result"`
}

type RemoveDeviceResult 

type RemoveDeviceResult struct {
}

type UpdateDeviceRequest 

type UpdateDeviceRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 设备Id  */
	DeviceId string `json:"deviceId"`

	/* 设备型号 (Optional) */
	Model *string `json:"model"`

	/* 设备厂商 (Optional) */
	Manufacturer *string `json:"manufacturer"`

	/* 设备描述 (Optional) */
	Description *string `json:"description"`

	/* 设备状态 (Optional) */
	Status *int `json:"status"`
}

func NewUpdateDeviceRequest 

func NewUpdateDeviceRequest(
	instanceId string,
	regionId string,
	deviceId string,
) *UpdateDeviceRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param deviceId: 设备Id (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateDeviceRequestWithAllParams 

func NewUpdateDeviceRequestWithAllParams(
	instanceId string,
	regionId string,
	deviceId string,
	model *string,
	manufacturer *string,
	description *string,
	status *int,
) *UpdateDeviceRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param deviceId: 设备Id (Required) * param model: 设备型号 (Optional) * param manufacturer: 设备厂商 (Optional) * param description: 设备描述 (Optional) * param status: 设备状态 (Optional)

func NewUpdateDeviceRequestWithoutParam 

func NewUpdateDeviceRequestWithoutParam() *UpdateDeviceRequest

This constructor has better compatible ability when API parameters changed

func (UpdateDeviceRequest) GetRegionId 

func (r UpdateDeviceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UpdateDeviceRequest) SetDescription 

func (r *UpdateDeviceRequest) SetDescription(description string)

param description: 设备描述(Optional)

func (*UpdateDeviceRequest) SetDeviceId 

func (r *UpdateDeviceRequest) SetDeviceId(deviceId string)

param deviceId: 设备Id(Required)

func (*UpdateDeviceRequest) SetInstanceId 

func (r *UpdateDeviceRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*UpdateDeviceRequest) SetManufacturer 

func (r *UpdateDeviceRequest) SetManufacturer(manufacturer string)

param manufacturer: 设备厂商(Optional)

func (*UpdateDeviceRequest) SetModel 

func (r *UpdateDeviceRequest) SetModel(model string)

param model: 设备型号(Optional)

func (*UpdateDeviceRequest) SetRegionId 

func (r *UpdateDeviceRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

func (*UpdateDeviceRequest) SetStatus added in v1.13.0 

func (r *UpdateDeviceRequest) SetStatus(status int)

param status: 设备状态(Optional)

type UpdateDeviceResponse 

type UpdateDeviceResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    UpdateDeviceResult `json:"result"`
}

type UpdateDeviceResult 

type UpdateDeviceResult struct {
	Device iotcore.DeviceVO `json:"device"`
}

type UpdateProductRequest 

type UpdateProductRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* IoT Engine实例ID信息  */
	InstanceId string `json:"instanceId"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`

	/* 产品名称，名称不可为空，3-30个字符，只支持汉字、英文字母、数字、下划线“_”及中划线“-”，必须以汉字、英文字母及数字开头结尾 (Optional) */
	ProductName *string `json:"productName"`

	/* 产品描述，80字符以内 (Optional) */
	ProductDescription *string `json:"productDescription"`

	/* 动态注册,0:关闭，1:开启 (Optional) */
	DynamicRegister *int `json:"dynamicRegister"`
}

func NewUpdateProductRequest 

func NewUpdateProductRequest(
	regionId string,
	instanceId string,
	productKey string,
) *UpdateProductRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Engine实例ID信息 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateProductRequestWithAllParams 

func NewUpdateProductRequestWithAllParams(
	regionId string,
	instanceId string,
	productKey string,
	productName *string,
	productDescription *string,
	dynamicRegister *int,
) *UpdateProductRequest

* param regionId: 地域ID (Required) * param instanceId: IoT Engine实例ID信息 (Required) * param productKey: 产品Key (Required) * param productName: 产品名称，名称不可为空，3-30个字符，只支持汉字、英文字母、数字、下划线“_”及中划线“-”，必须以汉字、英文字母及数字开头结尾 (Optional) * param productDescription: 产品描述，80字符以内 (Optional) * param dynamicRegister: 动态注册,0:关闭，1:开启 (Optional)

func NewUpdateProductRequestWithoutParam 

func NewUpdateProductRequestWithoutParam() *UpdateProductRequest

This constructor has better compatible ability when API parameters changed

func (UpdateProductRequest) GetRegionId 

func (r UpdateProductRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UpdateProductRequest) SetDynamicRegister 

func (r *UpdateProductRequest) SetDynamicRegister(dynamicRegister int)

param dynamicRegister: 动态注册,0:关闭，1:开启(Optional)

func (*UpdateProductRequest) SetInstanceId 

func (r *UpdateProductRequest) SetInstanceId(instanceId string)

param instanceId: IoT Engine实例ID信息(Required)

func (*UpdateProductRequest) SetProductDescription 

func (r *UpdateProductRequest) SetProductDescription(productDescription string)

param productDescription: 产品描述，80字符以内(Optional)

func (*UpdateProductRequest) SetProductKey 

func (r *UpdateProductRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*UpdateProductRequest) SetProductName 

func (r *UpdateProductRequest) SetProductName(productName string)

param productName: 产品名称，名称不可为空，3-30个字符，只支持汉字、英文字母、数字、下划线“_”及中划线“-”，必须以汉字、英文字母及数字开头结尾(Optional)

func (*UpdateProductRequest) SetRegionId 

func (r *UpdateProductRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type UpdateProductResponse 

type UpdateProductResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    UpdateProductResult `json:"result"`
}

type UpdateProductResult 

type UpdateProductResult struct {
}

type UpdateThingShadowRequest 

type UpdateThingShadowRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例ID  */
	InstanceId string `json:"instanceId"`

	/* 设备归属的实例所在区域  */
	RegionId string `json:"regionId"`

	/* 设备唯一标识  */
	Identifier string `json:"identifier"`

	/* 产品Key  */
	ProductKey string `json:"productKey"`

	/* 运行状态 (Optional) */
	State *interface{} `json:"state"`

	/* 设备影子版本,当前版本加1，当前版本默认其实版本为-1
	用户主动更新版本号时，设备影子会检查请求中的主动更新版本号是否大于当前版本号。
	如果大于当前版本号，则更新设备影子，并将影子版本值更新到请求的版本中，反之则会拒绝更新设备影子。
	影子版本参数为Integer型
	取值范围：0到2147483647(2的31次方-1)
	当取值达到最大值2147483647(2的31次方-1)时，请求中的主动更新版本号应为-1
	 (Optional) */
	Version *int `json:"version"`
}

func NewUpdateThingShadowRequest 

func NewUpdateThingShadowRequest(
	instanceId string,
	regionId string,
	identifier string,
	productKey string,
) *UpdateThingShadowRequest

* param instanceId: 设备归属的实例ID (Required) * param regionId: 设备归属的实例所在区域 (Required) * param identifier: 设备唯一标识 (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateThingShadowRequestWithAllParams 

func NewUpdateThingShadowRequestWithAllParams(
	instanceId string,
	regionId string,
	identifier string,
	productKey string,
	state *interface{},
	version *int,
) *UpdateThingShadowRequest
  • param instanceId: 设备归属的实例ID (Required)
  • param regionId: 设备归属的实例所在区域 (Required)
  • param identifier: 设备唯一标识 (Required)
  • param productKey: 产品Key (Required)
  • param state: 运行状态 (Optional)
  • param version: 设备影子版本,当前版本加1，当前版本默认其实版本为-1

用户主动更新版本号时，设备影子会检查请求中的主动更新版本号是否大于当前版本号。 如果大于当前版本号，则更新设备影子，并将影子版本值更新到请求的版本中，反之则会拒绝更新设备影子。 影子版本参数为Integer型 取值范围：0到2147483647(2的31次方-1) 当取值达到最大值2147483647(2的31次方-1)时，请求中的主动更新版本号应为-1 

(Optional)

func NewUpdateThingShadowRequestWithoutParam 

func NewUpdateThingShadowRequestWithoutParam() *UpdateThingShadowRequest

This constructor has better compatible ability when API parameters changed

func (UpdateThingShadowRequest) GetRegionId 

func (r UpdateThingShadowRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UpdateThingShadowRequest) SetIdentifier 

func (r *UpdateThingShadowRequest) SetIdentifier(identifier string)

param identifier: 设备唯一标识(Required)

func (*UpdateThingShadowRequest) SetInstanceId 

func (r *UpdateThingShadowRequest) SetInstanceId(instanceId string)

param instanceId: 设备归属的实例ID(Required)

func (*UpdateThingShadowRequest) SetProductKey 

func (r *UpdateThingShadowRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*UpdateThingShadowRequest) SetRegionId 

func (r *UpdateThingShadowRequest) SetRegionId(regionId string)

param regionId: 设备归属的实例所在区域(Required)

func (*UpdateThingShadowRequest) SetState 

func (r *UpdateThingShadowRequest) SetState(state interface{})

param state: 运行状态(Optional)

func (*UpdateThingShadowRequest) SetVersion 

func (r *UpdateThingShadowRequest) SetVersion(version int)
param version: 设备影子版本,当前版本加1，当前版本默认其实版本为-1

用户主动更新版本号时，设备影子会检查请求中的主动更新版本号是否大于当前版本号。 如果大于当前版本号，则更新设备影子，并将影子版本值更新到请求的版本中，反之则会拒绝更新设备影子。 影子版本参数为Integer型 取值范围：0到2147483647(2的31次方-1) 当取值达到最大值2147483647(2的31次方-1)时，请求中的主动更新版本号应为-1 (Optional)

type UpdateThingShadowResponse 

type UpdateThingShadowResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    UpdateThingShadowResult `json:"result"`
}

type UpdateThingShadowResult 

type UpdateThingShadowResult struct {
}

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.