v20210408

package
v3.0.469+incompatible Latest Latest
Warning

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

 Go to latest Published: Jul 3, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// This device has been transferred and cannot be created again.
	FAILEDOPERATION_ALREADYDISTRIBUTIONDEVICE = "FailedOperation.AlreadyDistributionDevice"

	// You cannot create devices as allowlist authentication is not enabled. IoT Hub will create devices automatically by the names carried during authentication.
	FAILEDOPERATION_TIDWHITELISTNOTOPEN = "FailedOperation.TidWhiteListNotOpen"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Parameter error.
	INVALIDPARAMETER = "InvalidParameter"

	// Invalid parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// Incorrect CA certificate content.
	INVALIDPARAMETERVALUE_CACERTINVALID = "InvalidParameterValue.CACertInvalid"

	// CA certificate mismatch.
	INVALIDPARAMETERVALUE_CACERTNOTMATCH = "InvalidParameterValue.CACertNotMatch"

	// Invalid format. `DefinedPsk` must be a Base64 string.
	INVALIDPARAMETERVALUE_DEFINEDPSKNOTBASE64 = "InvalidParameterValue.DefinedPskNotBase64"

	// The device already exists.
	INVALIDPARAMETERVALUE_DEVICEALREADYEXIST = "InvalidParameterValue.DeviceAlreadyExist"

	// This product name already exists.
	INVALIDPARAMETERVALUE_PRODUCTALREADYEXIST = "InvalidParameterValue.ProductAlreadyExist"

	// Unsupported product type.
	INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"

	// This TID product already exists.
	INVALIDPARAMETERVALUE_TIDPRODUCTALREADYEXIST = "InvalidParameterValue.TidProductAlreadyExist"

	// Unable to operate because the CA certificate is already bound to a product.
	LIMITEXCEEDED_CAALREADYBINDPRODUCT = "LimitExceeded.CAAlreadyBindProduct"

	//
	LIMITEXCEEDED_CACERTNAMEREPEAT = "LimitExceeded.CACertNameRepeat"

	// The CA certificate already exists.
	LIMITEXCEEDED_CAREPEAT = "LimitExceeded.CARepeat"

	// Device quantity exceeded the limit.
	LIMITEXCEEDED_DEVICEEXCEEDLIMIT = "LimitExceeded.DeviceExceedLimit"

	// The number of products exceeds the limit.
	LIMITEXCEEDED_PRODUCTEXCEEDLIMIT = "LimitExceeded.ProductExceedLimit"

	// The CA certificate does not exist.
	RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

	// The device does not exist.
	RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"

	// The product does not exist.
	RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

	// The TSL model does not exist.
	RESOURCENOTFOUND_THINGMODELNOTEXIST = "ResourceNotFound.ThingModelNotExist"

	// Unable to delete this device as gateway devices have been bound to it.
	UNAUTHORIZEDOPERATION_DEVICEHASALREADYBINDGATEWAY = "UnauthorizedOperation.DeviceHasAlreadyBindGateway"

	// The device is not enabled.
	UNAUTHORIZEDOPERATION_DEVICEISNOTENABLED = "UnauthorizedOperation.DeviceIsNotEnabled"

	// There are still devices under this product.
	UNAUTHORIZEDOPERATION_DEVICESEXISTUNDERPRODUCT = "UnauthorizedOperation.DevicesExistUnderProduct"

	// There are still devices bound to this device.
	UNAUTHORIZEDOPERATION_GATEWAYHASBINDEDDEVICES = "UnauthorizedOperation.GatewayHasBindedDevices"

	// You cannot create a LoRa device under this product type.
	UNAUTHORIZEDOPERATION_PRODUCTCANTHAVELORADEVICE = "UnauthorizedOperation.ProductCantHaveLoRaDevice"

	// You cannot create a general device under a NB-IoT product.
	UNAUTHORIZEDOPERATION_PRODUCTCANTHAVENORMALDEVICE = "UnauthorizedOperation.ProductCantHaveNormalDevice"

	// You can create only LoRa devices under this product type.
	UNAUTHORIZEDOPERATION_PRODUCTCANTHAVENOTLORADEVICE = "UnauthorizedOperation.ProductCantHaveNotLoRaDevice"

	// This feature has been disabled for the product.
	UNAUTHORIZEDOPERATION_PRODUCTISFORBIDDEN = "UnauthorizedOperation.ProductIsForbidden"

	// The product does not support key authentication.
	UNAUTHORIZEDOPERATION_PRODUCTNOTSUPPORTPSK = "UnauthorizedOperation.ProductNotSupportPSK"

	// The user identity is not verified.
	UNAUTHORIZEDOPERATION_USERNOTAUTHENTICAED = "UnauthorizedOperation.UserNotAuthenticaed"

	// Device OTA update is in progress.
	UNSUPPORTEDOPERATION_DEVICEOTATASKINPROGRESS = "UnsupportedOperation.DeviceOtaTaskInProgress"

	// Unable to delete this gateway product as sub-products have been bound to it.
	UNSUPPORTEDOPERATION_GATEWAYPRODUCTHASBINDEDPRODUCT = "UnsupportedOperation.GatewayProductHasBindedProduct"

	// Unable to delete this product as gateway devices have been bound to it.
	UNSUPPORTEDOPERATION_PRODUCTHASBINDGATEWAY = "UnsupportedOperation.ProductHasBindGateway"

	// Unable to delete this product as gateway products have been bound to it.
	UNSUPPORTEDOPERATION_PRODUCTHASBINDEDGATEWAYPRODUCT = "UnsupportedOperation.ProductHasBindedGatewayProduct"

	// You cannot create devices under a suite token product.
	UNSUPPORTEDOPERATION_SUITETOKENNOCREATE = "UnsupportedOperation.SuiteTokenNoCreate"
)
View Source 
const APIVersion = "2021-04-08"

Variables

This section is empty.

Functions

This section is empty.

Types

type Attribute 

type Attribute struct {
	// Attribute list
	Tags []*DeviceTag `json:"Tags,omitempty" name:"Tags"`
}

type BindProductInfo 

type BindProductInfo struct {
	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Product name
	ProductName *string `json:"ProductName,omitempty" name:"ProductName"`
}

type CertInfo 

type CertInfo struct {
	// Certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`

	// Hex sequence number of a certificate
	CertSN *string `json:"CertSN,omitempty" name:"CertSN"`

	// Certificate issuer
	IssuerName *string `json:"IssuerName,omitempty" name:"IssuerName"`

	// Certificate subject
	Subject *string `json:"Subject,omitempty" name:"Subject"`

	// Certificate creation time (timestamp in milliseconds)
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Certificate effective time (timestamp in milliseconds)
	EffectiveTime *uint64 `json:"EffectiveTime,omitempty" name:"EffectiveTime"`

	// Certificate expiration time (timestamp in milliseconds)
	ExpireTime *uint64 `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// X.509 certificate content
	CertText *string `json:"CertText,omitempty" name:"CertText"`
}

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateDevice 

func (c *Client) CreateDevice(request *CreateDeviceRequest) (response *CreateDeviceResponse, err error)

CreateDevice This API is used to create an IoT Hub device.

error code that may be returned: 

FAILEDOPERATION_ALREADYDISTRIBUTIONDEVICE = "FailedOperation.AlreadyDistributionDevice"
FAILEDOPERATION_TIDWHITELISTNOTOPEN = "FailedOperation.TidWhiteListNotOpen"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_DEFINEDPSKNOTBASE64 = "InvalidParameterValue.DefinedPskNotBase64"
INVALIDPARAMETERVALUE_DEVICEALREADYEXIST = "InvalidParameterValue.DeviceAlreadyExist"
INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"
LIMITEXCEEDED_DEVICEEXCEEDLIMIT = "LimitExceeded.DeviceExceedLimit"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_PRODUCTCANTHAVELORADEVICE = "UnauthorizedOperation.ProductCantHaveLoRaDevice"
UNAUTHORIZEDOPERATION_PRODUCTCANTHAVENORMALDEVICE = "UnauthorizedOperation.ProductCantHaveNormalDevice"
UNAUTHORIZEDOPERATION_PRODUCTCANTHAVENOTLORADEVICE = "UnauthorizedOperation.ProductCantHaveNotLoRaDevice"
UNAUTHORIZEDOPERATION_PRODUCTISFORBIDDEN = "UnauthorizedOperation.ProductIsForbidden"
UNAUTHORIZEDOPERATION_PRODUCTNOTSUPPORTPSK = "UnauthorizedOperation.ProductNotSupportPSK"
UNSUPPORTEDOPERATION_SUITETOKENNOCREATE = "UnsupportedOperation.SuiteTokenNoCreate"

func (*Client) CreateDeviceWithContext 

func (c *Client) CreateDeviceWithContext(ctx context.Context, request *CreateDeviceRequest) (response *CreateDeviceResponse, err error)

CreateDevice This API is used to create an IoT Hub device.

error code that may be returned: 

FAILEDOPERATION_ALREADYDISTRIBUTIONDEVICE = "FailedOperation.AlreadyDistributionDevice"
FAILEDOPERATION_TIDWHITELISTNOTOPEN = "FailedOperation.TidWhiteListNotOpen"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_DEFINEDPSKNOTBASE64 = "InvalidParameterValue.DefinedPskNotBase64"
INVALIDPARAMETERVALUE_DEVICEALREADYEXIST = "InvalidParameterValue.DeviceAlreadyExist"
INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"
LIMITEXCEEDED_DEVICEEXCEEDLIMIT = "LimitExceeded.DeviceExceedLimit"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_PRODUCTCANTHAVELORADEVICE = "UnauthorizedOperation.ProductCantHaveLoRaDevice"
UNAUTHORIZEDOPERATION_PRODUCTCANTHAVENORMALDEVICE = "UnauthorizedOperation.ProductCantHaveNormalDevice"
UNAUTHORIZEDOPERATION_PRODUCTCANTHAVENOTLORADEVICE = "UnauthorizedOperation.ProductCantHaveNotLoRaDevice"
UNAUTHORIZEDOPERATION_PRODUCTISFORBIDDEN = "UnauthorizedOperation.ProductIsForbidden"
UNAUTHORIZEDOPERATION_PRODUCTNOTSUPPORTPSK = "UnauthorizedOperation.ProductNotSupportPSK"
UNSUPPORTEDOPERATION_SUITETOKENNOCREATE = "UnsupportedOperation.SuiteTokenNoCreate"

func (*Client) CreatePrivateCA 

func (c *Client) CreatePrivateCA(request *CreatePrivateCARequest) (response *CreatePrivateCAResponse, err error)

CreatePrivateCA This API is used to create a private CA certificate.

error code that may be returned: 

INVALIDPARAMETERVALUE_CACERTINVALID = "InvalidParameterValue.CACertInvalid"
INVALIDPARAMETERVALUE_CACERTNOTMATCH = "InvalidParameterValue.CACertNotMatch"
LIMITEXCEEDED_CACERTNAMEREPEAT = "LimitExceeded.CACertNameRepeat"
LIMITEXCEEDED_CAREPEAT = "LimitExceeded.CARepeat"

func (*Client) CreatePrivateCAWithContext 

func (c *Client) CreatePrivateCAWithContext(ctx context.Context, request *CreatePrivateCARequest) (response *CreatePrivateCAResponse, err error)

CreatePrivateCA This API is used to create a private CA certificate.

error code that may be returned: 

INVALIDPARAMETERVALUE_CACERTINVALID = "InvalidParameterValue.CACertInvalid"
INVALIDPARAMETERVALUE_CACERTNOTMATCH = "InvalidParameterValue.CACertNotMatch"
LIMITEXCEEDED_CACERTNAMEREPEAT = "LimitExceeded.CACertNameRepeat"
LIMITEXCEEDED_CAREPEAT = "LimitExceeded.CARepeat"

func (*Client) CreateProduct 

func (c *Client) CreateProduct(request *CreateProductRequest) (response *CreateProductResponse, err error)

CreateProduct This API is used to create a new IoT communication product.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_PRODUCTALREADYEXIST = "InvalidParameterValue.ProductAlreadyExist"
INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"
INVALIDPARAMETERVALUE_TIDPRODUCTALREADYEXIST = "InvalidParameterValue.TidProductAlreadyExist"
LIMITEXCEEDED_PRODUCTEXCEEDLIMIT = "LimitExceeded.ProductExceedLimit"
RESOURCENOTFOUND_THINGMODELNOTEXIST = "ResourceNotFound.ThingModelNotExist"
UNAUTHORIZEDOPERATION_USERNOTAUTHENTICAED = "UnauthorizedOperation.UserNotAuthenticaed"

func (*Client) CreateProductWithContext 

func (c *Client) CreateProductWithContext(ctx context.Context, request *CreateProductRequest) (response *CreateProductResponse, err error)

CreateProduct This API is used to create a new IoT communication product.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_PRODUCTALREADYEXIST = "InvalidParameterValue.ProductAlreadyExist"
INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"
INVALIDPARAMETERVALUE_TIDPRODUCTALREADYEXIST = "InvalidParameterValue.TidProductAlreadyExist"
LIMITEXCEEDED_PRODUCTEXCEEDLIMIT = "LimitExceeded.ProductExceedLimit"
RESOURCENOTFOUND_THINGMODELNOTEXIST = "ResourceNotFound.ThingModelNotExist"
UNAUTHORIZEDOPERATION_USERNOTAUTHENTICAED = "UnauthorizedOperation.UserNotAuthenticaed"

func (*Client) DeleteDevice 

func (c *Client) DeleteDevice(request *DeleteDeviceRequest) (response *DeleteDeviceResponse, err error)

DeleteDevice This API is used to delete an IoT Hub device.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_DEVICEHASALREADYBINDGATEWAY = "UnauthorizedOperation.DeviceHasAlreadyBindGateway"
UNAUTHORIZEDOPERATION_GATEWAYHASBINDEDDEVICES = "UnauthorizedOperation.GatewayHasBindedDevices"
UNSUPPORTEDOPERATION_DEVICEOTATASKINPROGRESS = "UnsupportedOperation.DeviceOtaTaskInProgress"

func (*Client) DeleteDeviceWithContext 

func (c *Client) DeleteDeviceWithContext(ctx context.Context, request *DeleteDeviceRequest) (response *DeleteDeviceResponse, err error)

DeleteDevice This API is used to delete an IoT Hub device.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_DEVICEHASALREADYBINDGATEWAY = "UnauthorizedOperation.DeviceHasAlreadyBindGateway"
UNAUTHORIZEDOPERATION_GATEWAYHASBINDEDDEVICES = "UnauthorizedOperation.GatewayHasBindedDevices"
UNSUPPORTEDOPERATION_DEVICEOTATASKINPROGRESS = "UnsupportedOperation.DeviceOtaTaskInProgress"

func (*Client) DeletePrivateCA 

func (c *Client) DeletePrivateCA(request *DeletePrivateCARequest) (response *DeletePrivateCAResponse, err error)

DeletePrivateCA This API is used to delete a private CA certificate.

error code that may be returned: 

LIMITEXCEEDED_CAALREADYBINDPRODUCT = "LimitExceeded.CAAlreadyBindProduct"
RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) DeletePrivateCAWithContext 

func (c *Client) DeletePrivateCAWithContext(ctx context.Context, request *DeletePrivateCARequest) (response *DeletePrivateCAResponse, err error)

DeletePrivateCA This API is used to delete a private CA certificate.

error code that may be returned: 

LIMITEXCEEDED_CAALREADYBINDPRODUCT = "LimitExceeded.CAAlreadyBindProduct"
RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) DeleteProduct 

func (c *Client) DeleteProduct(request *DeleteProductRequest) (response *DeleteProductResponse, err error)

DeleteProduct This API is used to delete an IoT Hub product.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_DEVICESEXISTUNDERPRODUCT = "UnauthorizedOperation.DevicesExistUnderProduct"
UNSUPPORTEDOPERATION_GATEWAYPRODUCTHASBINDEDPRODUCT = "UnsupportedOperation.GatewayProductHasBindedProduct"
UNSUPPORTEDOPERATION_PRODUCTHASBINDGATEWAY = "UnsupportedOperation.ProductHasBindGateway"
UNSUPPORTEDOPERATION_PRODUCTHASBINDEDGATEWAYPRODUCT = "UnsupportedOperation.ProductHasBindedGatewayProduct"

func (*Client) DeleteProductWithContext 

func (c *Client) DeleteProductWithContext(ctx context.Context, request *DeleteProductRequest) (response *DeleteProductResponse, err error)

DeleteProduct This API is used to delete an IoT Hub product.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_DEVICESEXISTUNDERPRODUCT = "UnauthorizedOperation.DevicesExistUnderProduct"
UNSUPPORTEDOPERATION_GATEWAYPRODUCTHASBINDEDPRODUCT = "UnsupportedOperation.GatewayProductHasBindedProduct"
UNSUPPORTEDOPERATION_PRODUCTHASBINDGATEWAY = "UnsupportedOperation.ProductHasBindGateway"
UNSUPPORTEDOPERATION_PRODUCTHASBINDEDGATEWAYPRODUCT = "UnsupportedOperation.ProductHasBindedGatewayProduct"

func (*Client) DescribeDevice 

func (c *Client) DescribeDevice(request *DescribeDeviceRequest) (response *DescribeDeviceResponse, err error)

DescribeDevice This API is used to query device details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) DescribeDeviceWithContext 

func (c *Client) DescribeDeviceWithContext(ctx context.Context, request *DescribeDeviceRequest) (response *DescribeDeviceResponse, err error)

DescribeDevice This API is used to query device details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) DescribeDevices 

func (c *Client) DescribeDevices(request *DescribeDevicesRequest) (response *DescribeDevicesResponse, err error)

DescribeDevices This API is used to get the list of IoT Hub devices.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) DescribeDevicesWithContext 

func (c *Client) DescribeDevicesWithContext(ctx context.Context, request *DescribeDevicesRequest) (response *DescribeDevicesResponse, err error)

DescribeDevices This API is used to get the list of IoT Hub devices.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) DescribePrivateCA 

func (c *Client) DescribePrivateCA(request *DescribePrivateCARequest) (response *DescribePrivateCAResponse, err error)

DescribePrivateCA This API is used to query private CA certificate details.

error code that may be returned: 

RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) DescribePrivateCABindedProducts 

func (c *Client) DescribePrivateCABindedProducts(request *DescribePrivateCABindedProductsRequest) (response *DescribePrivateCABindedProductsResponse, err error)

DescribePrivateCABindedProducts This API is used to query the products bound to a private CA certificate.

error code that may be returned: 

RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) DescribePrivateCABindedProductsWithContext 

func (c *Client) DescribePrivateCABindedProductsWithContext(ctx context.Context, request *DescribePrivateCABindedProductsRequest) (response *DescribePrivateCABindedProductsResponse, err error)

DescribePrivateCABindedProducts This API is used to query the products bound to a private CA certificate.

error code that may be returned: 

RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) DescribePrivateCAWithContext 

func (c *Client) DescribePrivateCAWithContext(ctx context.Context, request *DescribePrivateCARequest) (response *DescribePrivateCAResponse, err error)

DescribePrivateCA This API is used to query private CA certificate details.

error code that may be returned: 

RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) DescribePrivateCAs 

func (c *Client) DescribePrivateCAs(request *DescribePrivateCAsRequest) (response *DescribePrivateCAsResponse, err error)

DescribePrivateCAs This API is used to get the list of private CA certificates.

error code that may be returned: 

RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) DescribePrivateCAsWithContext 

func (c *Client) DescribePrivateCAsWithContext(ctx context.Context, request *DescribePrivateCAsRequest) (response *DescribePrivateCAsResponse, err error)

DescribePrivateCAs This API is used to get the list of private CA certificates.

error code that may be returned: 

RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) DescribeProduct 

func (c *Client) DescribeProduct(request *DescribeProductRequest) (response *DescribeProductResponse, err error)

DescribeProduct This API is used to query product details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) DescribeProductCA 

func (c *Client) DescribeProductCA(request *DescribeProductCARequest) (response *DescribeProductCAResponse, err error)

DescribeProductCA This API is used to query the CA certificates bound to a product.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) DescribeProductCAWithContext 

func (c *Client) DescribeProductCAWithContext(ctx context.Context, request *DescribeProductCARequest) (response *DescribeProductCAResponse, err error)

DescribeProductCA This API is used to query the CA certificates bound to a product.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) DescribeProductWithContext 

func (c *Client) DescribeProductWithContext(ctx context.Context, request *DescribeProductRequest) (response *DescribeProductResponse, err error)

DescribeProduct This API is used to query product details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) DescribeProducts 

func (c *Client) DescribeProducts(request *DescribeProductsRequest) (response *DescribeProductsResponse, err error)

DescribeProducts This API is used to obtain the product list.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DescribeProductsWithContext 

func (c *Client) DescribeProductsWithContext(ctx context.Context, request *DescribeProductsRequest) (response *DescribeProductsResponse, err error)

DescribeProducts This API is used to obtain the product list.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) SetProductsForbiddenStatus 

func (c *Client) SetProductsForbiddenStatus(request *SetProductsForbiddenStatusRequest) (response *SetProductsForbiddenStatusResponse, err error)

SetProductsForbiddenStatus This API is used to enable or disable multiple products at a time.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) SetProductsForbiddenStatusWithContext 

func (c *Client) SetProductsForbiddenStatusWithContext(ctx context.Context, request *SetProductsForbiddenStatusRequest) (response *SetProductsForbiddenStatusResponse, err error)

SetProductsForbiddenStatus This API is used to enable or disable multiple products at a time.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"

func (*Client) UpdateDeviceLogLevel 

func (c *Client) UpdateDeviceLogLevel(request *UpdateDeviceLogLevelRequest) (response *UpdateDeviceLogLevelResponse, err error)

UpdateDeviceLogLevel This API is used to set the device log level.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"
UNAUTHORIZEDOPERATION_DEVICEISNOTENABLED = "UnauthorizedOperation.DeviceIsNotEnabled"

func (*Client) UpdateDeviceLogLevelWithContext 

func (c *Client) UpdateDeviceLogLevelWithContext(ctx context.Context, request *UpdateDeviceLogLevelRequest) (response *UpdateDeviceLogLevelResponse, err error)

UpdateDeviceLogLevel This API is used to set the device log level.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"
UNAUTHORIZEDOPERATION_DEVICEISNOTENABLED = "UnauthorizedOperation.DeviceIsNotEnabled"

func (*Client) UpdateDevicesEnableState 

func (c *Client) UpdateDevicesEnableState(request *UpdateDevicesEnableStateRequest) (response *UpdateDevicesEnableStateResponse, err error)

UpdateDevicesEnableState This API is used to enable or disable multiple devices.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"
RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_DEVICEHASALREADYBINDGATEWAY = "UnauthorizedOperation.DeviceHasAlreadyBindGateway"

func (*Client) UpdateDevicesEnableStateWithContext 

func (c *Client) UpdateDevicesEnableStateWithContext(ctx context.Context, request *UpdateDevicesEnableStateRequest) (response *UpdateDevicesEnableStateResponse, err error)

UpdateDevicesEnableState This API is used to enable or disable multiple devices.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"
RESOURCENOTFOUND_DEVICENOTEXIST = "ResourceNotFound.DeviceNotExist"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_DEVICEHASALREADYBINDGATEWAY = "UnauthorizedOperation.DeviceHasAlreadyBindGateway"

func (*Client) UpdatePrivateCA 

func (c *Client) UpdatePrivateCA(request *UpdatePrivateCARequest) (response *UpdatePrivateCAResponse, err error)

UpdatePrivateCA This API is used to update a private CA certificate.

error code that may be returned: 

INVALIDPARAMETERVALUE_CACERTINVALID = "InvalidParameterValue.CACertInvalid"
INVALIDPARAMETERVALUE_CACERTNOTMATCH = "InvalidParameterValue.CACertNotMatch"
LIMITEXCEEDED_CAREPEAT = "LimitExceeded.CARepeat"
RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) UpdatePrivateCAWithContext 

func (c *Client) UpdatePrivateCAWithContext(ctx context.Context, request *UpdatePrivateCARequest) (response *UpdatePrivateCAResponse, err error)

UpdatePrivateCA This API is used to update a private CA certificate.

error code that may be returned: 

INVALIDPARAMETERVALUE_CACERTINVALID = "InvalidParameterValue.CACertInvalid"
INVALIDPARAMETERVALUE_CACERTNOTMATCH = "InvalidParameterValue.CACertNotMatch"
LIMITEXCEEDED_CAREPEAT = "LimitExceeded.CARepeat"
RESOURCENOTFOUND_CACERTNOTEXIST = "ResourceNotFound.CACertNotExist"

func (*Client) UpdateProductDynamicRegister 

func (c *Client) UpdateProductDynamicRegister(request *UpdateProductDynamicRegisterRequest) (response *UpdateProductDynamicRegisterResponse, err error)

UpdateProductDynamicRegister This API is used to update the configuration of product dynamic registration.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_PRODUCTISFORBIDDEN = "UnauthorizedOperation.ProductIsForbidden"

func (*Client) UpdateProductDynamicRegisterWithContext 

func (c *Client) UpdateProductDynamicRegisterWithContext(ctx context.Context, request *UpdateProductDynamicRegisterRequest) (response *UpdateProductDynamicRegisterResponse, err error)

UpdateProductDynamicRegister This API is used to update the configuration of product dynamic registration.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_PRODUCTTYPENOTSUPPORT = "InvalidParameterValue.ProductTypeNotSupport"
RESOURCENOTFOUND_PRODUCTNOTEXIST = "ResourceNotFound.ProductNotExist"
UNAUTHORIZEDOPERATION_PRODUCTISFORBIDDEN = "UnauthorizedOperation.ProductIsForbidden"

type CreateDeviceRequest 

type CreateDeviceRequest struct {
	*tchttp.BaseRequest

	// Product ID, globally unique ID assigned by Tencent Cloud during product creation
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Device name. It is a string of 1 to 48 characters. Letters, digits, and :_- are allowed.
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Device attribute
	Attribute *Attribute `json:"Attribute,omitempty" name:"Attribute"`

	// Whether to use custom PSK, no by default
	DefinedPsk *string `json:"DefinedPsk,omitempty" name:"DefinedPsk"`

	// ISP, required for a NB-IoT product. `1`: China Telecom; `2`: China Mobile; `3`: China Unicom
	Isp *uint64 `json:"Isp,omitempty" name:"Isp"`

	// IMEI, required for a NB-IoT product
	Imei *string `json:"Imei,omitempty" name:"Imei"`

	// DevEUI of a LoRa device, required when you create a LoRa device
	LoraDevEui *string `json:"LoraDevEui,omitempty" name:"LoraDevEui"`

	// MoteType of a LoRa device
	LoraMoteType *uint64 `json:"LoraMoteType,omitempty" name:"LoraMoteType"`

	// Skey, required when you create a LoRa device
	Skey *string `json:"Skey,omitempty" name:"Skey"`

	// AppKey of a LoRa device
	LoraAppKey *string `json:"LoraAppKey,omitempty" name:"LoraAppKey"`

	// Private CA certificate
	TlsCrt *string `json:"TlsCrt,omitempty" name:"TlsCrt"`
}

func NewCreateDeviceRequest 

func NewCreateDeviceRequest() (request *CreateDeviceRequest)

func (*CreateDeviceRequest) FromJsonString 

func (r *CreateDeviceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateDeviceRequest) ToJsonString 

func (r *CreateDeviceRequest) ToJsonString() string

type CreateDeviceRequestParams 

type CreateDeviceRequestParams struct {
	// Product ID, globally unique ID assigned by Tencent Cloud during product creation
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Device name. It is a string of 1 to 48 characters. Letters, digits, and :_- are allowed.
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Device attribute
	Attribute *Attribute `json:"Attribute,omitempty" name:"Attribute"`

	// Whether to use custom PSK, no by default
	DefinedPsk *string `json:"DefinedPsk,omitempty" name:"DefinedPsk"`

	// ISP, required for a NB-IoT product. `1`: China Telecom; `2`: China Mobile; `3`: China Unicom
	Isp *uint64 `json:"Isp,omitempty" name:"Isp"`

	// IMEI, required for a NB-IoT product
	Imei *string `json:"Imei,omitempty" name:"Imei"`

	// DevEUI of a LoRa device, required when you create a LoRa device
	LoraDevEui *string `json:"LoraDevEui,omitempty" name:"LoraDevEui"`

	// MoteType of a LoRa device
	LoraMoteType *uint64 `json:"LoraMoteType,omitempty" name:"LoraMoteType"`

	// Skey, required when you create a LoRa device
	Skey *string `json:"Skey,omitempty" name:"Skey"`

	// AppKey of a LoRa device
	LoraAppKey *string `json:"LoraAppKey,omitempty" name:"LoraAppKey"`

	// Private CA certificate
	TlsCrt *string `json:"TlsCrt,omitempty" name:"TlsCrt"`
}

Predefined struct for user

type CreateDeviceResponse 

type CreateDeviceResponse struct {
	*tchttp.BaseResponse
	Response *CreateDeviceResponseParams `json:"Response"`
}

func NewCreateDeviceResponse 

func NewCreateDeviceResponse() (response *CreateDeviceResponse)

func (*CreateDeviceResponse) FromJsonString 

func (r *CreateDeviceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateDeviceResponse) ToJsonString 

func (r *CreateDeviceResponse) ToJsonString() string

type CreateDeviceResponseParams 

type CreateDeviceResponseParams struct {
	// Device name
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Base64-encoded symmetric encryption key, which is returned if symmetric encryption is used
	DevicePsk *string `json:"DevicePsk,omitempty" name:"DevicePsk"`

	// Device certificate, which authenticates client identity during TLS connection establishment and is returned if asymmetric encryption is used
	DeviceCert *string `json:"DeviceCert,omitempty" name:"DeviceCert"`

	// Device private key, which authenticates client identity during TLS connection establishment and is returned if asymmetric encryption is used. Tencent Cloud does not store the key. Please store it by yourself properly.
	DevicePrivateKey *string `json:"DevicePrivateKey,omitempty" name:"DevicePrivateKey"`

	// DevEUI of a LoRa device, which is returned for a LoRa device
	LoraDevEui *string `json:"LoraDevEui,omitempty" name:"LoraDevEui"`

	// MoteType of a LoRa device, which is returned for a LoRa device
	LoraMoteType *uint64 `json:"LoraMoteType,omitempty" name:"LoraMoteType"`

	// AppKey of a LoRa device, which is returned for a LoRa device
	LoraAppKey *string `json:"LoraAppKey,omitempty" name:"LoraAppKey"`

	// NwkKey of a LoRa device, which is returned for a LoRa device
	LoraNwkKey *string `json:"LoraNwkKey,omitempty" name:"LoraNwkKey"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreatePrivateCARequest 

type CreatePrivateCARequest struct {
	*tchttp.BaseRequest

	// CA certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`

	// CA certificate content
	CertText *string `json:"CertText,omitempty" name:"CertText"`

	// Content verifying the CA certificate
	VerifyCertText *string `json:"VerifyCertText,omitempty" name:"VerifyCertText"`
}

func NewCreatePrivateCARequest 

func NewCreatePrivateCARequest() (request *CreatePrivateCARequest)

func (*CreatePrivateCARequest) FromJsonString 

func (r *CreatePrivateCARequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreatePrivateCARequest) ToJsonString 

func (r *CreatePrivateCARequest) ToJsonString() string

type CreatePrivateCARequestParams 

type CreatePrivateCARequestParams struct {
	// CA certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`

	// CA certificate content
	CertText *string `json:"CertText,omitempty" name:"CertText"`

	// Content verifying the CA certificate
	VerifyCertText *string `json:"VerifyCertText,omitempty" name:"VerifyCertText"`
}

Predefined struct for user

type CreatePrivateCAResponse 

type CreatePrivateCAResponse struct {
	*tchttp.BaseResponse
	Response *CreatePrivateCAResponseParams `json:"Response"`
}

func NewCreatePrivateCAResponse 

func NewCreatePrivateCAResponse() (response *CreatePrivateCAResponse)

func (*CreatePrivateCAResponse) FromJsonString 

func (r *CreatePrivateCAResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreatePrivateCAResponse) ToJsonString 

func (r *CreatePrivateCAResponse) ToJsonString() string

type CreatePrivateCAResponseParams 

type CreatePrivateCAResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateProductRequest 

type CreateProductRequest struct {
	*tchttp.BaseRequest

	// Product name, which cannot be same as that of an existing product. Naming rule: [a-zA-Z0-9:_-]{1,32}.
	ProductName *string `json:"ProductName,omitempty" name:"ProductName"`

	// Product properties
	ProductProperties *ProductProperties `json:"ProductProperties,omitempty" name:"ProductProperties"`

	// Skey, which is required to create a CLAA product.
	Skey *string `json:"Skey,omitempty" name:"Skey"`
}

func NewCreateProductRequest 

func NewCreateProductRequest() (request *CreateProductRequest)

func (*CreateProductRequest) FromJsonString 

func (r *CreateProductRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateProductRequest) ToJsonString 

func (r *CreateProductRequest) ToJsonString() string

type CreateProductRequestParams 

type CreateProductRequestParams struct {
	// Product name, which cannot be same as that of an existing product. Naming rule: [a-zA-Z0-9:_-]{1,32}.
	ProductName *string `json:"ProductName,omitempty" name:"ProductName"`

	// Product properties
	ProductProperties *ProductProperties `json:"ProductProperties,omitempty" name:"ProductProperties"`

	// Skey, which is required to create a CLAA product.
	Skey *string `json:"Skey,omitempty" name:"Skey"`
}

Predefined struct for user

type CreateProductResponse 

type CreateProductResponse struct {
	*tchttp.BaseResponse
	Response *CreateProductResponseParams `json:"Response"`
}

func NewCreateProductResponse 

func NewCreateProductResponse() (response *CreateProductResponse)

func (*CreateProductResponse) FromJsonString 

func (r *CreateProductResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateProductResponse) ToJsonString 

func (r *CreateProductResponse) ToJsonString() string

type CreateProductResponseParams 

type CreateProductResponseParams struct {
	// Product name
	ProductName *string `json:"ProductName,omitempty" name:"ProductName"`

	// Product ID, the globally unique ID assigned by Tencent Cloud.
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Product properties
	ProductProperties *ProductProperties `json:"ProductProperties,omitempty" name:"ProductProperties"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteDeviceRequest 

type DeleteDeviceRequest struct {
	*tchttp.BaseRequest

	// ID of the product to which the device belongs
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Name of the device to delete
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Skey, which is required to delete a LoRa device or LoRa gateway device
	Skey *string `json:"Skey,omitempty" name:"Skey"`
}

func NewDeleteDeviceRequest 

func NewDeleteDeviceRequest() (request *DeleteDeviceRequest)

func (*DeleteDeviceRequest) FromJsonString 

func (r *DeleteDeviceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteDeviceRequest) ToJsonString 

func (r *DeleteDeviceRequest) ToJsonString() string

type DeleteDeviceRequestParams 

type DeleteDeviceRequestParams struct {
	// ID of the product to which the device belongs
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Name of the device to delete
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Skey, which is required to delete a LoRa device or LoRa gateway device
	Skey *string `json:"Skey,omitempty" name:"Skey"`
}

Predefined struct for user

type DeleteDeviceResponse 

type DeleteDeviceResponse struct {
	*tchttp.BaseResponse
	Response *DeleteDeviceResponseParams `json:"Response"`
}

func NewDeleteDeviceResponse 

func NewDeleteDeviceResponse() (response *DeleteDeviceResponse)

func (*DeleteDeviceResponse) FromJsonString 

func (r *DeleteDeviceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteDeviceResponse) ToJsonString 

func (r *DeleteDeviceResponse) ToJsonString() string

type DeleteDeviceResponseParams 

type DeleteDeviceResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeletePrivateCARequest 

type DeletePrivateCARequest struct {
	*tchttp.BaseRequest

	// Private CA certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`
}

func NewDeletePrivateCARequest 

func NewDeletePrivateCARequest() (request *DeletePrivateCARequest)

func (*DeletePrivateCARequest) FromJsonString 

func (r *DeletePrivateCARequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeletePrivateCARequest) ToJsonString 

func (r *DeletePrivateCARequest) ToJsonString() string

type DeletePrivateCARequestParams 

type DeletePrivateCARequestParams struct {
	// Private CA certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`
}

Predefined struct for user

type DeletePrivateCAResponse 

type DeletePrivateCAResponse struct {
	*tchttp.BaseResponse
	Response *DeletePrivateCAResponseParams `json:"Response"`
}

func NewDeletePrivateCAResponse 

func NewDeletePrivateCAResponse() (response *DeletePrivateCAResponse)

func (*DeletePrivateCAResponse) FromJsonString 

func (r *DeletePrivateCAResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeletePrivateCAResponse) ToJsonString 

func (r *DeletePrivateCAResponse) ToJsonString() string

type DeletePrivateCAResponseParams 

type DeletePrivateCAResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteProductRequest 

type DeleteProductRequest struct {
	*tchttp.BaseRequest

	// ID of the product to delete
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Skey, which is required to delete a LoRa product
	Skey *string `json:"Skey,omitempty" name:"Skey"`
}

func NewDeleteProductRequest 

func NewDeleteProductRequest() (request *DeleteProductRequest)

func (*DeleteProductRequest) FromJsonString 

func (r *DeleteProductRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteProductRequest) ToJsonString 

func (r *DeleteProductRequest) ToJsonString() string

type DeleteProductRequestParams 

type DeleteProductRequestParams struct {
	// ID of the product to delete
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Skey, which is required to delete a LoRa product
	Skey *string `json:"Skey,omitempty" name:"Skey"`
}

Predefined struct for user

type DeleteProductResponse 

type DeleteProductResponse struct {
	*tchttp.BaseResponse
	Response *DeleteProductResponseParams `json:"Response"`
}

func NewDeleteProductResponse 

func NewDeleteProductResponse() (response *DeleteProductResponse)

func (*DeleteProductResponse) FromJsonString 

func (r *DeleteProductResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteProductResponse) ToJsonString 

func (r *DeleteProductResponse) ToJsonString() string

type DeleteProductResponseParams 

type DeleteProductResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDeviceRequest 

type DescribeDeviceRequest struct {
	*tchttp.BaseRequest

	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Device name
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`
}

func NewDescribeDeviceRequest 

func NewDescribeDeviceRequest() (request *DescribeDeviceRequest)

func (*DescribeDeviceRequest) FromJsonString 

func (r *DescribeDeviceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDeviceRequest) ToJsonString 

func (r *DescribeDeviceRequest) ToJsonString() string

type DescribeDeviceRequestParams 

type DescribeDeviceRequestParams struct {
	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Device name
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`
}

Predefined struct for user

type DescribeDeviceResponse 

type DescribeDeviceResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDeviceResponseParams `json:"Response"`
}

func NewDescribeDeviceResponse 

func NewDescribeDeviceResponse() (response *DescribeDeviceResponse)

func (*DescribeDeviceResponse) FromJsonString 

func (r *DescribeDeviceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDeviceResponse) ToJsonString 

func (r *DescribeDeviceResponse) ToJsonString() string

type DescribeDeviceResponseParams 

type DescribeDeviceResponseParams struct {
	// Device name
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Whether the device is online. `0`: offline; `1`: online
	Online *uint64 `json:"Online,omitempty" name:"Online"`

	// Device login time
	LoginTime *uint64 `json:"LoginTime,omitempty" name:"LoginTime"`

	// Device firmware version
	Version *string `json:"Version,omitempty" name:"Version"`

	// Last updated time of the device
	LastUpdateTime *uint64 `json:"LastUpdateTime,omitempty" name:"LastUpdateTime"`

	// Device certificate
	DeviceCert *string `json:"DeviceCert,omitempty" name:"DeviceCert"`

	// Device key
	DevicePsk *string `json:"DevicePsk,omitempty" name:"DevicePsk"`

	// Device attribute
	Tags []*DeviceTag `json:"Tags,omitempty" name:"Tags"`

	// Device type
	DeviceType *uint64 `json:"DeviceType,omitempty" name:"DeviceType"`

	// International Mobile Equipment Identity (IMEI)
	Imei *string `json:"Imei,omitempty" name:"Imei"`

	// ISP
	Isp *uint64 `json:"Isp,omitempty" name:"Isp"`

	// IP address
	ConnIP *uint64 `json:"ConnIP,omitempty" name:"ConnIP"`

	// Device ID at the NB-IoT ISP
	NbiotDeviceID *string `json:"NbiotDeviceID,omitempty" name:"NbiotDeviceID"`

	// DevEUI of a LoRa device
	LoraDevEui *string `json:"LoraDevEui,omitempty" name:"LoraDevEui"`

	// MoteType of a LoRa device
	LoraMoteType *uint64 `json:"LoraMoteType,omitempty" name:"LoraMoteType"`

	// SDK log level of the device
	// Note: this field may return `null`, indicating that no valid value is obtained.
	LogLevel *uint64 `json:"LogLevel,omitempty" name:"LogLevel"`

	// The first time when the device went online
	// Note: this field may return `null`, indicating that no valid value is obtained.
	FirstOnlineTime *uint64 `json:"FirstOnlineTime,omitempty" name:"FirstOnlineTime"`

	// The last time when the device went offline
	// Note: this field may return `null`, indicating that no valid value is obtained.
	LastOfflineTime *uint64 `json:"LastOfflineTime,omitempty" name:"LastOfflineTime"`

	// Device creation time
	// Note: this field may return `null`, indicating that no valid value is obtained.
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Whether the device certificate has been obtained. `0`: no; `1`: yes
	// Note: this field may return `null`, indicating that no valid value is obtained.
	CertState *uint64 `json:"CertState,omitempty" name:"CertState"`

	// Whether the device is enabled
	// Note: this field may return `null`, indicating that no valid value is obtained.
	EnableState *uint64 `json:"EnableState,omitempty" name:"EnableState"`

	// Device tags
	// Note: this field may return `null`, indicating that no valid value is obtained.
	Labels []*DeviceLabel `json:"Labels,omitempty" name:"Labels"`

	// IP address of the MQTT client
	// Note: this field may return `null`, indicating that no valid value is obtained.
	ClientIP *string `json:"ClientIP,omitempty" name:"ClientIP"`

	// Firmware update time of the device
	// Note: this field may return `null`, indicating that no valid value is obtained.
	FirmwareUpdateTime *uint64 `json:"FirmwareUpdateTime,omitempty" name:"FirmwareUpdateTime"`

	// Account ID of the creator
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	CreateUserId *uint64 `json:"CreateUserId,omitempty" name:"CreateUserId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDevicesRequest 

type DescribeDevicesRequest struct {
	*tchttp.BaseRequest

	// ID of the product whose devices are queried
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Offset, which starts from 0
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Page size. Value range: 10-250
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Device firmware version. If no value is passed in, devices of all firmware versions are returned. If `None-FirmwareVersion` is passed in, devices without version numbers are returned.
	FirmwareVersion *string `json:"FirmwareVersion,omitempty" name:"FirmwareVersion"`

	// Device name to query
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Whether to query enabled or disabled devices. `0`: disabled devices; `1`: enabled devices. By default, both enabled and disabled devices are queried.
	EnableState *uint64 `json:"EnableState,omitempty" name:"EnableState"`
}

func NewDescribeDevicesRequest 

func NewDescribeDevicesRequest() (request *DescribeDevicesRequest)

func (*DescribeDevicesRequest) FromJsonString 

func (r *DescribeDevicesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDevicesRequest) ToJsonString 

func (r *DescribeDevicesRequest) ToJsonString() string

type DescribeDevicesRequestParams 

type DescribeDevicesRequestParams struct {
	// ID of the product whose devices are queried
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Offset, which starts from 0
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Page size. Value range: 10-250
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Device firmware version. If no value is passed in, devices of all firmware versions are returned. If `None-FirmwareVersion` is passed in, devices without version numbers are returned.
	FirmwareVersion *string `json:"FirmwareVersion,omitempty" name:"FirmwareVersion"`

	// Device name to query
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Whether to query enabled or disabled devices. `0`: disabled devices; `1`: enabled devices. By default, both enabled and disabled devices are queried.
	EnableState *uint64 `json:"EnableState,omitempty" name:"EnableState"`
}

Predefined struct for user

type DescribeDevicesResponse 

type DescribeDevicesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDevicesResponseParams `json:"Response"`
}

func NewDescribeDevicesResponse 

func NewDescribeDevicesResponse() (response *DescribeDevicesResponse)

func (*DescribeDevicesResponse) FromJsonString 

func (r *DescribeDevicesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDevicesResponse) ToJsonString 

func (r *DescribeDevicesResponse) ToJsonString() string

type DescribeDevicesResponseParams 

type DescribeDevicesResponseParams struct {
	// Total number of the devices returned
	TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// List of device details
	Devices []*DeviceInfo `json:"Devices,omitempty" name:"Devices"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePrivateCABindedProductsRequest 

type DescribePrivateCABindedProductsRequest struct {
	*tchttp.BaseRequest

	// Certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`

	// Offset for query
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Maximum number of records to return, which is 20 by default and cannot exceed 200
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribePrivateCABindedProductsRequest 

func NewDescribePrivateCABindedProductsRequest() (request *DescribePrivateCABindedProductsRequest)

func (*DescribePrivateCABindedProductsRequest) FromJsonString 

func (r *DescribePrivateCABindedProductsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePrivateCABindedProductsRequest) ToJsonString 

func (r *DescribePrivateCABindedProductsRequest) ToJsonString() string

type DescribePrivateCABindedProductsRequestParams 

type DescribePrivateCABindedProductsRequestParams struct {
	// Certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`

	// Offset for query
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Maximum number of records to return, which is 20 by default and cannot exceed 200
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribePrivateCABindedProductsResponse 

type DescribePrivateCABindedProductsResponse struct {
	*tchttp.BaseResponse
	Response *DescribePrivateCABindedProductsResponseParams `json:"Response"`
}

func NewDescribePrivateCABindedProductsResponse 

func NewDescribePrivateCABindedProductsResponse() (response *DescribePrivateCABindedProductsResponse)

func (*DescribePrivateCABindedProductsResponse) FromJsonString 

func (r *DescribePrivateCABindedProductsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePrivateCABindedProductsResponse) ToJsonString 

func (r *DescribePrivateCABindedProductsResponse) ToJsonString() string

type DescribePrivateCABindedProductsResponseParams 

type DescribePrivateCABindedProductsResponseParams struct {
	// List of the products bound to the private CA certificate
	Products []*BindProductInfo `json:"Products,omitempty" name:"Products"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePrivateCARequest 

type DescribePrivateCARequest struct {
	*tchttp.BaseRequest

	// Name of the private CA certificate to query
	CertName *string `json:"CertName,omitempty" name:"CertName"`
}

func NewDescribePrivateCARequest 

func NewDescribePrivateCARequest() (request *DescribePrivateCARequest)

func (*DescribePrivateCARequest) FromJsonString 

func (r *DescribePrivateCARequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePrivateCARequest) ToJsonString 

func (r *DescribePrivateCARequest) ToJsonString() string

type DescribePrivateCARequestParams 

type DescribePrivateCARequestParams struct {
	// Name of the private CA certificate to query
	CertName *string `json:"CertName,omitempty" name:"CertName"`
}

Predefined struct for user

type DescribePrivateCAResponse 

type DescribePrivateCAResponse struct {
	*tchttp.BaseResponse
	Response *DescribePrivateCAResponseParams `json:"Response"`
}

func NewDescribePrivateCAResponse 

func NewDescribePrivateCAResponse() (response *DescribePrivateCAResponse)

func (*DescribePrivateCAResponse) FromJsonString 

func (r *DescribePrivateCAResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePrivateCAResponse) ToJsonString 

func (r *DescribePrivateCAResponse) ToJsonString() string

type DescribePrivateCAResponseParams 

type DescribePrivateCAResponseParams struct {
	// Details of the private CA certificate
	CA *CertInfo `json:"CA,omitempty" name:"CA"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePrivateCAsRequest 

type DescribePrivateCAsRequest struct {
	*tchttp.BaseRequest
}

func NewDescribePrivateCAsRequest 

func NewDescribePrivateCAsRequest() (request *DescribePrivateCAsRequest)

func (*DescribePrivateCAsRequest) FromJsonString 

func (r *DescribePrivateCAsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePrivateCAsRequest) ToJsonString 

func (r *DescribePrivateCAsRequest) ToJsonString() string

type DescribePrivateCAsRequestParams 

type DescribePrivateCAsRequestParams struct {
}

Predefined struct for user

type DescribePrivateCAsResponse 

type DescribePrivateCAsResponse struct {
	*tchttp.BaseResponse
	Response *DescribePrivateCAsResponseParams `json:"Response"`
}

func NewDescribePrivateCAsResponse 

func NewDescribePrivateCAsResponse() (response *DescribePrivateCAsResponse)

func (*DescribePrivateCAsResponse) FromJsonString 

func (r *DescribePrivateCAsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePrivateCAsResponse) ToJsonString 

func (r *DescribePrivateCAsResponse) ToJsonString() string

type DescribePrivateCAsResponseParams 

type DescribePrivateCAsResponseParams struct {
	// List of private CA certificates
	CAs []*CertInfo `json:"CAs,omitempty" name:"CAs"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeProductCARequest 

type DescribeProductCARequest struct {
	*tchttp.BaseRequest

	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`
}

func NewDescribeProductCARequest 

func NewDescribeProductCARequest() (request *DescribeProductCARequest)

func (*DescribeProductCARequest) FromJsonString 

func (r *DescribeProductCARequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeProductCARequest) ToJsonString 

func (r *DescribeProductCARequest) ToJsonString() string

type DescribeProductCARequestParams 

type DescribeProductCARequestParams struct {
	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`
}

Predefined struct for user

type DescribeProductCAResponse 

type DescribeProductCAResponse struct {
	*tchttp.BaseResponse
	Response *DescribeProductCAResponseParams `json:"Response"`
}

func NewDescribeProductCAResponse 

func NewDescribeProductCAResponse() (response *DescribeProductCAResponse)

func (*DescribeProductCAResponse) FromJsonString 

func (r *DescribeProductCAResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeProductCAResponse) ToJsonString 

func (r *DescribeProductCAResponse) ToJsonString() string

type DescribeProductCAResponseParams 

type DescribeProductCAResponseParams struct {
	// List of CA certificates bound to the product
	CAs []*CertInfo `json:"CAs,omitempty" name:"CAs"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeProductRequest 

type DescribeProductRequest struct {
	*tchttp.BaseRequest

	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`
}

func NewDescribeProductRequest 

func NewDescribeProductRequest() (request *DescribeProductRequest)

func (*DescribeProductRequest) FromJsonString 

func (r *DescribeProductRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeProductRequest) ToJsonString 

func (r *DescribeProductRequest) ToJsonString() string

type DescribeProductRequestParams 

type DescribeProductRequestParams struct {
	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`
}

Predefined struct for user

type DescribeProductResponse 

type DescribeProductResponse struct {
	*tchttp.BaseResponse
	Response *DescribeProductResponseParams `json:"Response"`
}

func NewDescribeProductResponse 

func NewDescribeProductResponse() (response *DescribeProductResponse)

func (*DescribeProductResponse) FromJsonString 

func (r *DescribeProductResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeProductResponse) ToJsonString 

func (r *DescribeProductResponse) ToJsonString() string

type DescribeProductResponseParams 

type DescribeProductResponseParams struct {
	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Product name
	ProductName *string `json:"ProductName,omitempty" name:"ProductName"`

	// Product metadata
	ProductMetadata *ProductMetadata `json:"ProductMetadata,omitempty" name:"ProductMetadata"`

	// Product properties
	ProductProperties *ProductProperties `json:"ProductProperties,omitempty" name:"ProductProperties"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeProductsRequest 

type DescribeProductsRequest struct {
	*tchttp.BaseRequest

	// Offset, starting from 0
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of entries returned per page. Valid range: 10–250.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeProductsRequest 

func NewDescribeProductsRequest() (request *DescribeProductsRequest)

func (*DescribeProductsRequest) FromJsonString 

func (r *DescribeProductsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeProductsRequest) ToJsonString 

func (r *DescribeProductsRequest) ToJsonString() string

type DescribeProductsRequestParams 

type DescribeProductsRequestParams struct {
	// Offset, starting from 0
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of entries returned per page. Valid range: 10–250.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeProductsResponse 

type DescribeProductsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeProductsResponseParams `json:"Response"`
}

func NewDescribeProductsResponse 

func NewDescribeProductsResponse() (response *DescribeProductsResponse)

func (*DescribeProductsResponse) FromJsonString 

func (r *DescribeProductsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeProductsResponse) ToJsonString 

func (r *DescribeProductsResponse) ToJsonString() string

type DescribeProductsResponseParams 

type DescribeProductsResponseParams struct {
	// Total number of products
	TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// List of product details
	Products []*ProductInfo `json:"Products,omitempty" name:"Products"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeviceInfo 

type DeviceInfo struct {
	// Device name
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Whether the device is online. `0`: offline; `1`: online
	Online *uint64 `json:"Online,omitempty" name:"Online"`

	// Device login time
	LoginTime *uint64 `json:"LoginTime,omitempty" name:"LoginTime"`

	// Device version
	Version *string `json:"Version,omitempty" name:"Version"`

	// Device certificate, which is returned for devices that use certificates for authentication
	DeviceCert *string `json:"DeviceCert,omitempty" name:"DeviceCert"`

	// Device key, which is returned for devices that use keys for authentication
	DevicePsk *string `json:"DevicePsk,omitempty" name:"DevicePsk"`

	// Device attribute
	Tags []*DeviceTag `json:"Tags,omitempty" name:"Tags"`

	// Device type
	DeviceType *uint64 `json:"DeviceType,omitempty" name:"DeviceType"`

	// International Mobile Equipment Identity (IMEI)
	Imei *string `json:"Imei,omitempty" name:"Imei"`

	// ISP
	Isp *uint64 `json:"Isp,omitempty" name:"Isp"`

	// Device ID at the NB-IoT ISP
	NbiotDeviceID *string `json:"NbiotDeviceID,omitempty" name:"NbiotDeviceID"`

	// IP address
	ConnIP *uint64 `json:"ConnIP,omitempty" name:"ConnIP"`

	// Last updated time of the device
	LastUpdateTime *uint64 `json:"LastUpdateTime,omitempty" name:"LastUpdateTime"`

	// DevEUI of a LoRa device
	LoraDevEui *string `json:"LoraDevEui,omitempty" name:"LoraDevEui"`

	// MoteType of a LoRa device
	LoraMoteType *uint64 `json:"LoraMoteType,omitempty" name:"LoraMoteType"`

	// The first time when the device went online
	// Note: this field may return `null`, indicating that no valid value is obtained.
	FirstOnlineTime *uint64 `json:"FirstOnlineTime,omitempty" name:"FirstOnlineTime"`

	// The last time when the device went offline
	// Note: this field may return `null`, indicating that no valid value is obtained.
	LastOfflineTime *uint64 `json:"LastOfflineTime,omitempty" name:"LastOfflineTime"`

	// Device creation time
	// Note: this field may return `null`, indicating that no valid value is obtained.
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Device log level
	// Note: this field may return `null`, indicating that no valid value is obtained.
	LogLevel *uint64 `json:"LogLevel,omitempty" name:"LogLevel"`

	// Whether the device certificate has been obtained. `0`: no; `1`: yes
	// Note: this field may return `null`, indicating that no valid value is obtained.
	CertState *uint64 `json:"CertState,omitempty" name:"CertState"`

	// Whether the device is enabled. `0`: disabled; `1`: enabled
	// Note: this field may return `null`, indicating that no valid value is obtained.
	EnableState *uint64 `json:"EnableState,omitempty" name:"EnableState"`

	// Device tags
	// Note: this field may return `null`, indicating that no valid value is obtained.
	Labels []*DeviceLabel `json:"Labels,omitempty" name:"Labels"`

	// IP address of the MQTT client
	// Note: this field may return `null`, indicating that no valid value is obtained.
	ClientIP *string `json:"ClientIP,omitempty" name:"ClientIP"`

	// Time of last OTA update
	// Note: this field may return `null`, indicating that no valid value is obtained.
	FirmwareUpdateTime *uint64 `json:"FirmwareUpdateTime,omitempty" name:"FirmwareUpdateTime"`
}

type DeviceLabel 

type DeviceLabel struct {
	// Tag key
	Key *string `json:"Key,omitempty" name:"Key"`

	// Tag value
	Value *string `json:"Value,omitempty" name:"Value"`
}

type DeviceTag 

type DeviceTag struct {
	// Attribute name
	Tag *string `json:"Tag,omitempty" name:"Tag"`

	// Attribute value type. `1`: integer; `2`: string
	Type *uint64 `json:"Type,omitempty" name:"Type"`

	// Attribute value
	Value *string `json:"Value,omitempty" name:"Value"`

	// Attribute description
	// Note: this field may return `null`, indicating that no valid value is obtained.
	Name *string `json:"Name,omitempty" name:"Name"`
}

type ProductInfo 

type ProductInfo struct {
	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Product name
	ProductName *string `json:"ProductName,omitempty" name:"ProductName"`

	// Product metadata
	ProductMetadata *ProductMetadata `json:"ProductMetadata,omitempty" name:"ProductMetadata"`

	// Product properties
	ProductProperties *ProductProperties `json:"ProductProperties,omitempty" name:"ProductProperties"`
}

type ProductMetadata 

type ProductMetadata struct {
	// Product creation time
	CreationDate *uint64 `json:"CreationDate,omitempty" name:"CreationDate"`
}

type ProductProperties 

type ProductProperties struct {
	// Product description
	ProductDescription *string `json:"ProductDescription,omitempty" name:"ProductDescription"`

	// Authentication type. `1` (default): certificate; `2`: signature
	EncryptionType *string `json:"EncryptionType,omitempty" name:"EncryptionType"`

	// Product region. Valid value: `gz` (Guangzhou)
	Region *string `json:"Region,omitempty" name:"Region"`

	// Product type. Valid values:
	// `0` (default): general; `2`: NB-IoT; `3`: LoRa gateway; `4`: LoRa; `5`: general gateway
	ProductType *uint64 `json:"ProductType,omitempty" name:"ProductType"`

	// Data format. Valid values: `json` (default), `custom`
	Format *string `json:"Format,omitempty" name:"Format"`

	// Platform of the product. Default value: `0`
	Platform *string `json:"Platform,omitempty" name:"Platform"`

	// AppEUI at the LoRa product operator, required only for LoRa products
	Appeui *string `json:"Appeui,omitempty" name:"Appeui"`

	// ID of the Thing Specification Language (TSL) model bound to the product. `-1` means no models are bound.
	ModelId *string `json:"ModelId,omitempty" name:"ModelId"`

	// Name of the TSL model bound to the product
	ModelName *string `json:"ModelName,omitempty" name:"ModelName"`

	// Product key, which is specific to suite products
	ProductKey *string `json:"ProductKey,omitempty" name:"ProductKey"`

	// Dynamic registration type. `0`: disable; `1`: preset device names; `2`: generate device names dynamically
	RegisterType *uint64 `json:"RegisterType,omitempty" name:"RegisterType"`

	// Dynamic registration product key
	ProductSecret *string `json:"ProductSecret,omitempty" name:"ProductSecret"`

	// The maximum number of devices that can be dynamically created when `RegisterType` is set to `2`
	RegisterLimit *uint64 `json:"RegisterLimit,omitempty" name:"RegisterLimit"`

	// Original product ID of a transferred product. This parameter is empty for products that are not transferred.
	OriginProductId *string `json:"OriginProductId,omitempty" name:"OriginProductId"`

	// Private CA certificate name
	PrivateCAName *string `json:"PrivateCAName,omitempty" name:"PrivateCAName"`

	// Original user ID of a transferred product. This parameter is empty for products that are not transferred.
	OriginUserId *uint64 `json:"OriginUserId,omitempty" name:"OriginUserId"`
}

type SetProductsForbiddenStatusRequest 

type SetProductsForbiddenStatusRequest struct {
	*tchttp.BaseRequest

	// List of products to enable or disable
	ProductId []*string `json:"ProductId,omitempty" name:"ProductId"`

	// `0`: enable; `1`: disable
	Status *uint64 `json:"Status,omitempty" name:"Status"`
}

func NewSetProductsForbiddenStatusRequest 

func NewSetProductsForbiddenStatusRequest() (request *SetProductsForbiddenStatusRequest)

func (*SetProductsForbiddenStatusRequest) FromJsonString 

func (r *SetProductsForbiddenStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetProductsForbiddenStatusRequest) ToJsonString 

func (r *SetProductsForbiddenStatusRequest) ToJsonString() string

type SetProductsForbiddenStatusRequestParams 

type SetProductsForbiddenStatusRequestParams struct {
	// List of products to enable or disable
	ProductId []*string `json:"ProductId,omitempty" name:"ProductId"`

	// `0`: enable; `1`: disable
	Status *uint64 `json:"Status,omitempty" name:"Status"`
}

Predefined struct for user

type SetProductsForbiddenStatusResponse 

type SetProductsForbiddenStatusResponse struct {
	*tchttp.BaseResponse
	Response *SetProductsForbiddenStatusResponseParams `json:"Response"`
}

func NewSetProductsForbiddenStatusResponse 

func NewSetProductsForbiddenStatusResponse() (response *SetProductsForbiddenStatusResponse)

func (*SetProductsForbiddenStatusResponse) FromJsonString 

func (r *SetProductsForbiddenStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetProductsForbiddenStatusResponse) ToJsonString 

func (r *SetProductsForbiddenStatusResponse) ToJsonString() string

type SetProductsForbiddenStatusResponseParams 

type SetProductsForbiddenStatusResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateDeviceLogLevelRequest 

type UpdateDeviceLogLevelRequest struct {
	*tchttp.BaseRequest

	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Device name
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Log level. `0`: disable; `1`: error; `2`: warning; `3`: information; `4`: debugging
	LogLevel *uint64 `json:"LogLevel,omitempty" name:"LogLevel"`
}

func NewUpdateDeviceLogLevelRequest 

func NewUpdateDeviceLogLevelRequest() (request *UpdateDeviceLogLevelRequest)

func (*UpdateDeviceLogLevelRequest) FromJsonString 

func (r *UpdateDeviceLogLevelRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateDeviceLogLevelRequest) ToJsonString 

func (r *UpdateDeviceLogLevelRequest) ToJsonString() string

type UpdateDeviceLogLevelRequestParams 

type UpdateDeviceLogLevelRequestParams struct {
	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Device name
	DeviceName *string `json:"DeviceName,omitempty" name:"DeviceName"`

	// Log level. `0`: disable; `1`: error; `2`: warning; `3`: information; `4`: debugging
	LogLevel *uint64 `json:"LogLevel,omitempty" name:"LogLevel"`
}

Predefined struct for user

type UpdateDeviceLogLevelResponse 

type UpdateDeviceLogLevelResponse struct {
	*tchttp.BaseResponse
	Response *UpdateDeviceLogLevelResponseParams `json:"Response"`
}

func NewUpdateDeviceLogLevelResponse 

func NewUpdateDeviceLogLevelResponse() (response *UpdateDeviceLogLevelResponse)

func (*UpdateDeviceLogLevelResponse) FromJsonString 

func (r *UpdateDeviceLogLevelResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateDeviceLogLevelResponse) ToJsonString 

func (r *UpdateDeviceLogLevelResponse) ToJsonString() string

type UpdateDeviceLogLevelResponseParams 

type UpdateDeviceLogLevelResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateDevicesEnableStateRequest 

type UpdateDevicesEnableStateRequest struct {
	*tchttp.BaseRequest

	// ID of the product to which the device belongs
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Device names
	DeviceNames []*string `json:"DeviceNames,omitempty" name:"DeviceNames"`

	// New status of the devices. `0`: disabled; `1`: enabled
	Status *uint64 `json:"Status,omitempty" name:"Status"`
}

func NewUpdateDevicesEnableStateRequest 

func NewUpdateDevicesEnableStateRequest() (request *UpdateDevicesEnableStateRequest)

func (*UpdateDevicesEnableStateRequest) FromJsonString 

func (r *UpdateDevicesEnableStateRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateDevicesEnableStateRequest) ToJsonString 

func (r *UpdateDevicesEnableStateRequest) ToJsonString() string

type UpdateDevicesEnableStateRequestParams 

type UpdateDevicesEnableStateRequestParams struct {
	// ID of the product to which the device belongs
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Device names
	DeviceNames []*string `json:"DeviceNames,omitempty" name:"DeviceNames"`

	// New status of the devices. `0`: disabled; `1`: enabled
	Status *uint64 `json:"Status,omitempty" name:"Status"`
}

Predefined struct for user

type UpdateDevicesEnableStateResponse 

type UpdateDevicesEnableStateResponse struct {
	*tchttp.BaseResponse
	Response *UpdateDevicesEnableStateResponseParams `json:"Response"`
}

func NewUpdateDevicesEnableStateResponse 

func NewUpdateDevicesEnableStateResponse() (response *UpdateDevicesEnableStateResponse)

func (*UpdateDevicesEnableStateResponse) FromJsonString 

func (r *UpdateDevicesEnableStateResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateDevicesEnableStateResponse) ToJsonString 

func (r *UpdateDevicesEnableStateResponse) ToJsonString() string

type UpdateDevicesEnableStateResponseParams 

type UpdateDevicesEnableStateResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdatePrivateCARequest 

type UpdatePrivateCARequest struct {
	*tchttp.BaseRequest

	// CA certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`

	// CA certificate content
	CertText *string `json:"CertText,omitempty" name:"CertText"`

	// Content verifying the CA certificate
	VerifyCertText *string `json:"VerifyCertText,omitempty" name:"VerifyCertText"`
}

func NewUpdatePrivateCARequest 

func NewUpdatePrivateCARequest() (request *UpdatePrivateCARequest)

func (*UpdatePrivateCARequest) FromJsonString 

func (r *UpdatePrivateCARequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdatePrivateCARequest) ToJsonString 

func (r *UpdatePrivateCARequest) ToJsonString() string

type UpdatePrivateCARequestParams 

type UpdatePrivateCARequestParams struct {
	// CA certificate name
	CertName *string `json:"CertName,omitempty" name:"CertName"`

	// CA certificate content
	CertText *string `json:"CertText,omitempty" name:"CertText"`

	// Content verifying the CA certificate
	VerifyCertText *string `json:"VerifyCertText,omitempty" name:"VerifyCertText"`
}

Predefined struct for user

type UpdatePrivateCAResponse 

type UpdatePrivateCAResponse struct {
	*tchttp.BaseResponse
	Response *UpdatePrivateCAResponseParams `json:"Response"`
}

func NewUpdatePrivateCAResponse 

func NewUpdatePrivateCAResponse() (response *UpdatePrivateCAResponse)

func (*UpdatePrivateCAResponse) FromJsonString 

func (r *UpdatePrivateCAResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdatePrivateCAResponse) ToJsonString 

func (r *UpdatePrivateCAResponse) ToJsonString() string

type UpdatePrivateCAResponseParams 

type UpdatePrivateCAResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateProductDynamicRegisterRequest 

type UpdateProductDynamicRegisterRequest struct {
	*tchttp.BaseRequest

	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Dynamic registration type. Valid values: 0 - disabled; 1 - pre-create device; 2 - auto-create device.
	RegisterType *uint64 `json:"RegisterType,omitempty" name:"RegisterType"`

	// Maximum dynamically registered devices
	RegisterLimit *uint64 `json:"RegisterLimit,omitempty" name:"RegisterLimit"`
}

func NewUpdateProductDynamicRegisterRequest 

func NewUpdateProductDynamicRegisterRequest() (request *UpdateProductDynamicRegisterRequest)

func (*UpdateProductDynamicRegisterRequest) FromJsonString 

func (r *UpdateProductDynamicRegisterRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateProductDynamicRegisterRequest) ToJsonString 

func (r *UpdateProductDynamicRegisterRequest) ToJsonString() string

type UpdateProductDynamicRegisterRequestParams 

type UpdateProductDynamicRegisterRequestParams struct {
	// Product ID
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Dynamic registration type. Valid values: 0 - disabled; 1 - pre-create device; 2 - auto-create device.
	RegisterType *uint64 `json:"RegisterType,omitempty" name:"RegisterType"`

	// Maximum dynamically registered devices
	RegisterLimit *uint64 `json:"RegisterLimit,omitempty" name:"RegisterLimit"`
}

Predefined struct for user

type UpdateProductDynamicRegisterResponse 

type UpdateProductDynamicRegisterResponse struct {
	*tchttp.BaseResponse
	Response *UpdateProductDynamicRegisterResponseParams `json:"Response"`
}

func NewUpdateProductDynamicRegisterResponse 

func NewUpdateProductDynamicRegisterResponse() (response *UpdateProductDynamicRegisterResponse)

func (*UpdateProductDynamicRegisterResponse) FromJsonString 

func (r *UpdateProductDynamicRegisterResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateProductDynamicRegisterResponse) ToJsonString 

func (r *UpdateProductDynamicRegisterResponse) ToJsonString() string

type UpdateProductDynamicRegisterResponseParams 

type UpdateProductDynamicRegisterResponseParams struct {
	// Dynamic registration type. Valid values: 0 - disabled; 1 - pre-create device; 2 - auto-create device.
	RegisterType *uint64 `json:"RegisterType,omitempty" name:"RegisterType"`

	// Product key for dynamic registration
	ProductSecret *string `json:"ProductSecret,omitempty" name:"ProductSecret"`

	// Maximum dynamically registered devices
	RegisterLimit *uint64 `json:"RegisterLimit,omitempty" name:"RegisterLimit"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

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.