apis

package
v1.62.0 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2023 License: Apache-2.0 Imports: 3 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddDeviceRequest added in v1.13.0 

type AddDeviceRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例所在区域  */
	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 added in v1.13.0 

func NewAddDeviceRequest(
	regionId string,
) *AddDeviceRequest

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

func NewAddDeviceRequestWithAllParams added in v1.13.0 

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

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

func NewAddDeviceRequestWithoutParam added in v1.13.0 

func NewAddDeviceRequestWithoutParam() *AddDeviceRequest

This constructor has better compatible ability when API parameters changed

func (AddDeviceRequest) GetRegionId added in v1.13.0 

func (r AddDeviceRequest) GetRegionId() string

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

func (*AddDeviceRequest) SetDescription added in v1.13.0 

func (r *AddDeviceRequest) SetDescription(description string)

param description: 设备描述(Optional)

func (*AddDeviceRequest) SetDeviceName added in v1.13.0 

func (r *AddDeviceRequest) SetDeviceName(deviceName string)

param deviceName: 设备名称(Optional)

func (*AddDeviceRequest) SetManufacturer added in v1.13.0 

func (r *AddDeviceRequest) SetManufacturer(manufacturer string)

param manufacturer: 厂商(Optional)

func (*AddDeviceRequest) SetModel added in v1.13.0 

func (r *AddDeviceRequest) SetModel(model string)

param model: 设备型号(Optional)

func (*AddDeviceRequest) SetProductKey added in v1.13.0 

func (r *AddDeviceRequest) SetProductKey(productKey string)

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

func (*AddDeviceRequest) SetRegionId added in v1.13.0 

func (r *AddDeviceRequest) SetRegionId(regionId string)

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

type AddDeviceResponse added in v1.13.0 

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

type AddDeviceResult added in v1.13.0 

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

type CreateProductRequest added in v1.13.0 

type CreateProductRequest struct {
	core.JDCloudRequest

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

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

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

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

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

func NewCreateProductRequest added in v1.13.0 

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

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

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

func NewCreateProductRequestWithAllParams added in v1.13.0 

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

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

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

func NewCreateProductRequestWithoutParam added in v1.13.0 

func NewCreateProductRequestWithoutParam() *CreateProductRequest

This constructor has better compatible ability when API parameters changed

func (CreateProductRequest) GetRegionId added in v1.13.0 

func (r CreateProductRequest) GetRegionId() string

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

func (*CreateProductRequest) SetProductDescription added in v1.13.0 

func (r *CreateProductRequest) SetProductDescription(productDescription string)

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

func (*CreateProductRequest) SetProductName added in v1.13.0 

func (r *CreateProductRequest) SetProductName(productName string)

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

func (*CreateProductRequest) SetProductType added in v1.13.0 

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

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

func (*CreateProductRequest) SetRegionId added in v1.13.0 

func (r *CreateProductRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

func (*CreateProductRequest) SetTemplateId added in v1.13.0 

func (r *CreateProductRequest) SetTemplateId(templateId string)

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

type CreateProductResponse added in v1.13.0 

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

type CreateProductResult added in v1.13.0 

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

type DeleteProductRequest added in v1.13.0 

type DeleteProductRequest struct {
	core.JDCloudRequest

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

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

func NewDeleteProductRequest added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteProductRequestWithAllParams added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required)

func NewDeleteProductRequestWithoutParam added in v1.13.0 

func NewDeleteProductRequestWithoutParam() *DeleteProductRequest

This constructor has better compatible ability when API parameters changed

func (DeleteProductRequest) GetRegionId added in v1.13.0 

func (r DeleteProductRequest) GetRegionId() string

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

func (*DeleteProductRequest) SetProductKey added in v1.13.0 

func (r *DeleteProductRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*DeleteProductRequest) SetRegionId added in v1.13.0 

func (r *DeleteProductRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type DeleteProductResponse added in v1.13.0 

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

type DeleteProductResult added in v1.13.0 

type DeleteProductResult struct {
}

type DescribeProductRequest added in v1.13.0 

type DescribeProductRequest struct {
	core.JDCloudRequest

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

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

func NewDescribeProductRequest added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeProductRequestWithAllParams added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required)

func NewDescribeProductRequestWithoutParam added in v1.13.0 

func NewDescribeProductRequestWithoutParam() *DescribeProductRequest

This constructor has better compatible ability when API parameters changed

func (DescribeProductRequest) GetRegionId added in v1.13.0 

func (r DescribeProductRequest) GetRegionId() string

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

func (*DescribeProductRequest) SetProductKey added in v1.13.0 

func (r *DescribeProductRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*DescribeProductRequest) SetRegionId added in v1.13.0 

func (r *DescribeProductRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type DescribeProductResponse added in v1.13.0 

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

type DescribeProductResult added in v1.13.0 

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 added in v1.13.0 

type DescribeThingShadowRequest struct {
	core.JDCloudRequest

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

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

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

func NewDescribeThingShadowRequest added in v1.13.0 

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

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

func NewDescribeThingShadowRequestWithAllParams added in v1.13.0 

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

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

func NewDescribeThingShadowRequestWithoutParam added in v1.13.0 

func NewDescribeThingShadowRequestWithoutParam() *DescribeThingShadowRequest

This constructor has better compatible ability when API parameters changed

func (DescribeThingShadowRequest) GetRegionId added in v1.13.0 

func (r DescribeThingShadowRequest) GetRegionId() string

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

func (*DescribeThingShadowRequest) SetIdentifier added in v1.13.0 

func (r *DescribeThingShadowRequest) SetIdentifier(identifier string)

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

func (*DescribeThingShadowRequest) SetProductKey added in v1.13.0 

func (r *DescribeThingShadowRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*DescribeThingShadowRequest) SetRegionId added in v1.13.0 

func (r *DescribeThingShadowRequest) SetRegionId(regionId string)

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

type DescribeThingShadowResponse added in v1.13.0 

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

type DescribeThingShadowResult added in v1.13.0 

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

type ExportThingModelRequest added in v1.13.0 

type ExportThingModelRequest struct {
	core.JDCloudRequest

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

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

func NewExportThingModelRequest added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewExportThingModelRequestWithAllParams added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required)

func NewExportThingModelRequestWithoutParam added in v1.13.0 

func NewExportThingModelRequestWithoutParam() *ExportThingModelRequest

This constructor has better compatible ability when API parameters changed

func (ExportThingModelRequest) GetRegionId added in v1.13.0 

func (r ExportThingModelRequest) GetRegionId() string

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

func (*ExportThingModelRequest) SetProductKey added in v1.13.0 

func (r *ExportThingModelRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*ExportThingModelRequest) SetRegionId added in v1.13.0 

func (r *ExportThingModelRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type ExportThingModelResponse added in v1.13.0 

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

type ExportThingModelResult added in v1.13.0 

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

type ImportThingModelRequest added in v1.13.0 

type ImportThingModelRequest struct {
	core.JDCloudRequest

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

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

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

func NewImportThingModelRequest added in v1.13.0 

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

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

func NewImportThingModelRequestWithAllParams added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required) * param thingModel: 物模型JSON (Required)

func NewImportThingModelRequestWithoutParam added in v1.13.0 

func NewImportThingModelRequestWithoutParam() *ImportThingModelRequest

This constructor has better compatible ability when API parameters changed

func (ImportThingModelRequest) GetRegionId added in v1.13.0 

func (r ImportThingModelRequest) GetRegionId() string

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

func (*ImportThingModelRequest) SetProductKey added in v1.13.0 

func (r *ImportThingModelRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*ImportThingModelRequest) SetRegionId added in v1.13.0 

func (r *ImportThingModelRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

func (*ImportThingModelRequest) SetThingModel added in v1.13.0 

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

param thingModel: 物模型JSON(Required)

type ImportThingModelResponse added in v1.13.0 

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

type ImportThingModelResult added in v1.13.0 

type ImportThingModelResult struct {
}

type InvokeThingServiceRequest added in v1.13.0 

type InvokeThingServiceRequest struct {
	core.JDCloudRequest

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

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

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

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

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

func NewInvokeThingServiceRequest added in v1.13.0 

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

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

func NewInvokeThingServiceRequestWithAllParams added in v1.13.0 

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

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

func NewInvokeThingServiceRequestWithoutParam added in v1.13.0 

func NewInvokeThingServiceRequestWithoutParam() *InvokeThingServiceRequest

This constructor has better compatible ability when API parameters changed

func (InvokeThingServiceRequest) GetRegionId added in v1.13.0 

func (r InvokeThingServiceRequest) GetRegionId() string

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

func (*InvokeThingServiceRequest) SetIdentifier added in v1.13.0 

func (r *InvokeThingServiceRequest) SetIdentifier(identifier string)

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

func (*InvokeThingServiceRequest) SetInput added in v1.13.0 

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

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

func (*InvokeThingServiceRequest) SetName added in v1.13.0 

func (r *InvokeThingServiceRequest) SetName(name string)

param name: 服务名称(Optional)

func (*InvokeThingServiceRequest) SetProductKey added in v1.13.0 

func (r *InvokeThingServiceRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*InvokeThingServiceRequest) SetRegionId added in v1.13.0 

func (r *InvokeThingServiceRequest) SetRegionId(regionId string)

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

type InvokeThingServiceResponse added in v1.13.0 

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

type InvokeThingServiceResult added in v1.13.0 

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

type ListProductAbilitiesRequest added in v1.13.0 

type ListProductAbilitiesRequest struct {
	core.JDCloudRequest

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

	/* 产品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 added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewListProductAbilitiesRequestWithAllParams added in v1.13.0 

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

abilityType-功能类型，精确匹配 

(Optional)

func NewListProductAbilitiesRequestWithoutParam added in v1.13.0 

func NewListProductAbilitiesRequestWithoutParam() *ListProductAbilitiesRequest

This constructor has better compatible ability when API parameters changed

func (ListProductAbilitiesRequest) GetRegionId added in v1.13.0 

func (r ListProductAbilitiesRequest) GetRegionId() string

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

func (*ListProductAbilitiesRequest) SetFilters added in v1.13.0 

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

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

func (*ListProductAbilitiesRequest) SetPageNumber added in v1.13.0 

func (r *ListProductAbilitiesRequest) SetPageNumber(pageNumber int)

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

func (*ListProductAbilitiesRequest) SetPageSize added in v1.13.0 

func (r *ListProductAbilitiesRequest) SetPageSize(pageSize int)

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

func (*ListProductAbilitiesRequest) SetProductKey added in v1.13.0 

func (r *ListProductAbilitiesRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*ListProductAbilitiesRequest) SetRegionId added in v1.13.0 

func (r *ListProductAbilitiesRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type ListProductAbilitiesResponse added in v1.13.0 

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

type ListProductAbilitiesResult added in v1.13.0 

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

type ListProductsRequest added in v1.13.0 

type ListProductsRequest struct {
	core.JDCloudRequest

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

	/* 页码, 默认为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 added in v1.13.0 

func NewListProductsRequest(
	regionId string,
) *ListProductsRequest

* param regionId: 地域ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewListProductsRequestWithAllParams added in v1.13.0 

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

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

(Optional)

func NewListProductsRequestWithoutParam added in v1.13.0 

func NewListProductsRequestWithoutParam() *ListProductsRequest

This constructor has better compatible ability when API parameters changed

func (ListProductsRequest) GetRegionId added in v1.13.0 

func (r ListProductsRequest) GetRegionId() string

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

func (*ListProductsRequest) SetFilters added in v1.13.0 

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

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

func (*ListProductsRequest) SetPageNumber added in v1.13.0 

func (r *ListProductsRequest) SetPageNumber(pageNumber int)

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

func (*ListProductsRequest) SetPageSize added in v1.13.0 

func (r *ListProductsRequest) SetPageSize(pageSize int)

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

func (*ListProductsRequest) SetRegionId added in v1.13.0 

func (r *ListProductsRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type ListProductsResponse added in v1.13.0 

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

type ListProductsResult added in v1.13.0 

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

type QueryDeviceDetailRequest added in v1.13.0 

type QueryDeviceDetailRequest struct {
	core.JDCloudRequest

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

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

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

func NewQueryDeviceDetailRequest added in v1.13.0 

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

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

func NewQueryDeviceDetailRequestWithAllParams added in v1.13.0 

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

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

func NewQueryDeviceDetailRequestWithoutParam added in v1.13.0 

func NewQueryDeviceDetailRequestWithoutParam() *QueryDeviceDetailRequest

This constructor has better compatible ability when API parameters changed

func (QueryDeviceDetailRequest) GetRegionId added in v1.13.0 

func (r QueryDeviceDetailRequest) GetRegionId() string

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

func (*QueryDeviceDetailRequest) SetDeviceName added in v1.13.0 

func (r *QueryDeviceDetailRequest) SetDeviceName(deviceName string)

param deviceName: 设备名称(Required)

func (*QueryDeviceDetailRequest) SetProductKey added in v1.13.0 

func (r *QueryDeviceDetailRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*QueryDeviceDetailRequest) SetRegionId added in v1.13.0 

func (r *QueryDeviceDetailRequest) SetRegionId(regionId string)

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

type QueryDeviceDetailResponse added in v1.13.0 

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

type QueryDeviceDetailResult added in v1.13.0 

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"`
}

type QueryDevicePageRequest added in v1.13.0 

type QueryDevicePageRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例所在区域  */
	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 added in v1.13.0 

func NewQueryDevicePageRequest(
	regionId string,
) *QueryDevicePageRequest

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

func NewQueryDevicePageRequestWithAllParams added in v1.13.0 

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

* 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 added in v1.13.0 

func NewQueryDevicePageRequestWithoutParam() *QueryDevicePageRequest

This constructor has better compatible ability when API parameters changed

func (QueryDevicePageRequest) GetRegionId added in v1.13.0 

func (r QueryDevicePageRequest) GetRegionId() string

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

func (*QueryDevicePageRequest) SetDeviceName added in v1.13.0 

func (r *QueryDevicePageRequest) SetDeviceName(deviceName string)

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

func (*QueryDevicePageRequest) SetDeviceType added in v1.13.0 

func (r *QueryDevicePageRequest) SetDeviceType(deviceType int)

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

func (*QueryDevicePageRequest) SetDirection added in v1.13.0 

func (r *QueryDevicePageRequest) SetDirection(direction string)

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

func (*QueryDevicePageRequest) SetNowPage added in v1.13.0 

func (r *QueryDevicePageRequest) SetNowPage(nowPage int)

param nowPage: 当前页数(Optional)

func (*QueryDevicePageRequest) SetOrder added in v1.13.0 

func (r *QueryDevicePageRequest) SetOrder(order string)

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

func (*QueryDevicePageRequest) SetPageSize added in v1.13.0 

func (r *QueryDevicePageRequest) SetPageSize(pageSize int)

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

func (*QueryDevicePageRequest) SetParentId added in v1.13.0 

func (r *QueryDevicePageRequest) SetParentId(parentId string)

param parentId: 父设备Id(Optional)

func (*QueryDevicePageRequest) SetProductKey added in v1.13.0 

func (r *QueryDevicePageRequest) SetProductKey(productKey string)

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

func (*QueryDevicePageRequest) SetRegionId added in v1.13.0 

func (r *QueryDevicePageRequest) SetRegionId(regionId string)

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

func (*QueryDevicePageRequest) SetStatus added in v1.13.0 

func (r *QueryDevicePageRequest) SetStatus(status int)

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

type QueryDevicePageResponse added in v1.13.0 

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

type QueryDevicePageResult added in v1.13.0 

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

type RemoveDeviceByIdRequest added in v1.13.0 

type RemoveDeviceByIdRequest struct {
	core.JDCloudRequest

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

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

func NewRemoveDeviceByIdRequest added in v1.13.0 

func NewRemoveDeviceByIdRequest(
	regionId string,
	deviceId string,
) *RemoveDeviceByIdRequest

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

func NewRemoveDeviceByIdRequestWithAllParams added in v1.13.0 

func NewRemoveDeviceByIdRequestWithAllParams(
	regionId string,
	deviceId string,
) *RemoveDeviceByIdRequest

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

func NewRemoveDeviceByIdRequestWithoutParam added in v1.13.0 

func NewRemoveDeviceByIdRequestWithoutParam() *RemoveDeviceByIdRequest

This constructor has better compatible ability when API parameters changed

func (RemoveDeviceByIdRequest) GetRegionId added in v1.13.0 

func (r RemoveDeviceByIdRequest) GetRegionId() string

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

func (*RemoveDeviceByIdRequest) SetDeviceId added in v1.13.0 

func (r *RemoveDeviceByIdRequest) SetDeviceId(deviceId string)

param deviceId: 设备Id(Required)

func (*RemoveDeviceByIdRequest) SetRegionId added in v1.13.0 

func (r *RemoveDeviceByIdRequest) SetRegionId(regionId string)

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

type RemoveDeviceByIdResponse added in v1.13.0 

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

type RemoveDeviceByIdResult added in v1.13.0 

type RemoveDeviceByIdResult struct {
}

type RemoveDeviceRequest added in v1.13.0 

type RemoveDeviceRequest struct {
	core.JDCloudRequest

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

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

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

func NewRemoveDeviceRequest added in v1.13.0 

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

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

func NewRemoveDeviceRequestWithAllParams added in v1.13.0 

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

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

func NewRemoveDeviceRequestWithoutParam added in v1.13.0 

func NewRemoveDeviceRequestWithoutParam() *RemoveDeviceRequest

This constructor has better compatible ability when API parameters changed

func (RemoveDeviceRequest) GetRegionId added in v1.13.0 

func (r RemoveDeviceRequest) GetRegionId() string

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

func (*RemoveDeviceRequest) SetDeviceName added in v1.13.0 

func (r *RemoveDeviceRequest) SetDeviceName(deviceName string)

param deviceName: 设备名称(Required)

func (*RemoveDeviceRequest) SetProductKey added in v1.13.0 

func (r *RemoveDeviceRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*RemoveDeviceRequest) SetRegionId added in v1.13.0 

func (r *RemoveDeviceRequest) SetRegionId(regionId string)

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

type RemoveDeviceResponse added in v1.13.0 

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

type RemoveDeviceResult added in v1.13.0 

type RemoveDeviceResult struct {
}

type UpdateDeviceRequest added in v1.13.0 

type UpdateDeviceRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例所在区域  */
	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 added in v1.13.0 

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

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

func NewUpdateDeviceRequestWithAllParams added in v1.13.0 

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

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

func NewUpdateDeviceRequestWithoutParam added in v1.13.0 

func NewUpdateDeviceRequestWithoutParam() *UpdateDeviceRequest

This constructor has better compatible ability when API parameters changed

func (UpdateDeviceRequest) GetRegionId added in v1.13.0 

func (r UpdateDeviceRequest) GetRegionId() string

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

func (*UpdateDeviceRequest) SetDescription added in v1.13.0 

func (r *UpdateDeviceRequest) SetDescription(description string)

param description: 设备描述(Optional)

func (*UpdateDeviceRequest) SetDeviceId added in v1.13.0 

func (r *UpdateDeviceRequest) SetDeviceId(deviceId string)

param deviceId: 设备Id(Required)

func (*UpdateDeviceRequest) SetManufacturer added in v1.13.0 

func (r *UpdateDeviceRequest) SetManufacturer(manufacturer string)

param manufacturer: 设备厂商(Optional)

func (*UpdateDeviceRequest) SetModel added in v1.13.0 

func (r *UpdateDeviceRequest) SetModel(model string)

param model: 设备型号(Optional)

func (*UpdateDeviceRequest) SetRegionId added in v1.13.0 

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 added in v1.13.0 

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

type UpdateDeviceResult added in v1.13.0 

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

type UpdateProductRequest added in v1.13.0 

type UpdateProductRequest struct {
	core.JDCloudRequest

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

	/* 产品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 added in v1.13.0 

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

* param regionId: 地域ID (Required) * param productKey: 产品Key (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateProductRequestWithAllParams added in v1.13.0 

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

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

func NewUpdateProductRequestWithoutParam added in v1.13.0 

func NewUpdateProductRequestWithoutParam() *UpdateProductRequest

This constructor has better compatible ability when API parameters changed

func (UpdateProductRequest) GetRegionId added in v1.13.0 

func (r UpdateProductRequest) GetRegionId() string

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

func (*UpdateProductRequest) SetDynamicRegister added in v1.13.0 

func (r *UpdateProductRequest) SetDynamicRegister(dynamicRegister int)

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

func (*UpdateProductRequest) SetProductDescription added in v1.13.0 

func (r *UpdateProductRequest) SetProductDescription(productDescription string)

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

func (*UpdateProductRequest) SetProductKey added in v1.13.0 

func (r *UpdateProductRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*UpdateProductRequest) SetProductName added in v1.13.0 

func (r *UpdateProductRequest) SetProductName(productName string)

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

func (*UpdateProductRequest) SetRegionId added in v1.13.0 

func (r *UpdateProductRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type UpdateProductResponse added in v1.13.0 

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

type UpdateProductResult added in v1.13.0 

type UpdateProductResult struct {
}

type UpdateThingShadowRequest added in v1.13.0 

type UpdateThingShadowRequest struct {
	core.JDCloudRequest

	/* 设备归属的实例所在区域  */
	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 added in v1.13.0 

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

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

func NewUpdateThingShadowRequestWithAllParams added in v1.13.0 

func NewUpdateThingShadowRequestWithAllParams(
	regionId string,
	identifier string,
	productKey string,
	state *interface{},
	version *int,
) *UpdateThingShadowRequest
  • 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 added in v1.13.0 

func NewUpdateThingShadowRequestWithoutParam() *UpdateThingShadowRequest

This constructor has better compatible ability when API parameters changed

func (UpdateThingShadowRequest) GetRegionId added in v1.13.0 

func (r UpdateThingShadowRequest) GetRegionId() string

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

func (*UpdateThingShadowRequest) SetIdentifier added in v1.13.0 

func (r *UpdateThingShadowRequest) SetIdentifier(identifier string)

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

func (*UpdateThingShadowRequest) SetProductKey added in v1.13.0 

func (r *UpdateThingShadowRequest) SetProductKey(productKey string)

param productKey: 产品Key(Required)

func (*UpdateThingShadowRequest) SetRegionId added in v1.13.0 

func (r *UpdateThingShadowRequest) SetRegionId(regionId string)

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

func (*UpdateThingShadowRequest) SetState added in v1.13.0 

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

param state: 运行状态(Optional)

func (*UpdateThingShadowRequest) SetVersion added in v1.13.0 

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

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

type UpdateThingShadowResponse added in v1.13.0 

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

type UpdateThingShadowResult added in v1.13.0 

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.