Documentation ¶
Index ¶
- type AccessInfo
- type AdditionalParams
- type AdditionalParamsResp
- type BindInstanceTags
- type BindInstanceTagsRequest
- type BindInstanceTagsResponse
- type ChangeInstanceChargeMode
- type ChangeInstanceChargeModeRequest
- type ChangeInstanceChargeModeResponse
- type ChargeInfo
- type CreateInstance
- type CreateInstanceRequest
- type CreateInstanceResponse
- type DeleteInstanceRequest
- type DeleteInstanceResponse
- type Flavor
- type ForwardingInfo
- type IpAllowList
- type IpWhiteList
- type ListInstancesRequest
- type ListInstancesResponse
- type OperateWindow
- type Port
- type QueryInstanceSimplify
- type ResizeInstance
- type ResizeInstanceRequest
- type ResizeInstanceResponse
- type ShowInstanceRequest
- type ShowInstanceResponse
- type Tag
- type UnbindInstanceTags
- type UnbindInstanceTagsRequest
- type UnbindInstanceTagsResponse
- type UpdateAccessInfo
- type UpdateForwardingInfo
- type UpdateInstance
- type UpdateInstanceRequest
- type UpdateInstanceResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessInfo ¶
type AccessInfo struct { // **参数说明**:接入地址的类型,如应用接入的HTTPS协议的取值为:APP_HTTPS,设备接入的MQTT协议的取值为:DEVICE_MQTT **取值范围**: - APP_HTTPS:应用接入HTTPS协议 - APP_AMQP:应用接入AMQP协议 - APP_MQTT:应用接入MQTT协议 - DEVICE_COAP:设备接入COAP协议 - DEVICE_MQTT:设备接入MQTT协议 - DEVICE_HTTPS:设备接入HTTPS协议 Type *string `json:"type,omitempty"` // **参数说明**:实例的应用/设备的安全接入端口 Port *int32 `json:"port,omitempty"` // **参数说明**:实例的应用/设备的非安全接入端口。返回null时表示该类型的接入地址不支持非安全端口接入。 NonTlsPort *int32 `json:"non_tls_port,omitempty"` // **参数说明**:基于WebSocket的MQTT接入端口。返回null时表示该类型的接入地址不支持WebSocket端口接入。 WebsocketPort *int32 `json:"websocket_port,omitempty"` // **参数说明**:实例的接入域名 DomainName *string `json:"domain_name,omitempty"` // **参数说明**:实例的私网接入地址列表 PrivateAddresses *[]string `json:"private_addresses,omitempty"` // **参数说明**:实例的公网接入地址 PublicAddress *[]string `json:"public_address,omitempty"` // **参数说明**:实例的ipv6接入地址列表 Ipv6Address *[]string `json:"ipv6_address,omitempty"` IpWhitelist *IpWhiteList `json:"ip_whitelist,omitempty"` }
AccessInfo 设备接入实例的接入信息。用户可以使用该结构体中的信息将应用服务器和设备接入到物联网平台。
func (AccessInfo) String ¶
func (o AccessInfo) String() string
type AdditionalParams ¶
type AdditionalParams struct { // **参数说明**:企业版实例的VPCID VpcId string `json:"vpc_id"` // **参数说明**:企业版实例的子网ID SubnetId string `json:"subnet_id"` // **参数说明**:企业版实例的安全组ID。请确保所选安全组已放通22端口(Linux SSH登录),3389端口(Windows远程登录)和ICMP协议(Ping) SecurityGroupId string `json:"security_group_id"` // **参数说明**:SMN的topic urn, 当企业版实例创建成功时,平台将通过该topic发送通知 SmnTopicUrn *string `json:"smn_topic_urn,omitempty"` // **参数说明**:实例支持的加密算法 **取值范围**: - COMMON_ALGORITHM: 通用加密算法(支持RSA,SHA256等国际通用的密码算法) - SM_ALGORITHM: 支持SM系列商密算法(支持SM2,SM3,SM4等国密算法) CipheringAlgorithm *string `json:"ciphering_algorithm,omitempty"` PortInfo *Port `json:"port_info"` }
AdditionalParams 企业版附加参数信息。
func (AdditionalParams) String ¶
func (o AdditionalParams) String() string
type AdditionalParamsResp ¶
type AdditionalParamsResp struct { // **参数说明**:企业版实例的VPCID VpcId *string `json:"vpc_id,omitempty"` // **参数说明**:企业版实例的子网ID SubnetId *string `json:"subnet_id,omitempty"` // **参数说明**:企业版实例的安全组ID SecurityGroupId *string `json:"security_group_id,omitempty"` // **参数说明**:实例支持的加密算法 **取值范围**: - COMMON_ALGORITHM: 通用加密算法(支持RSA,SHA256等国际通用的密码算法) - SM_ALGORITHM: 支持SM系列商密算法(支持SM2,SM3,SM4等国密算法) CipheringAlgorithm *string `json:"ciphering_algorithm,omitempty"` ForwardingInfo *ForwardingInfo `json:"forwarding_info,omitempty"` }
AdditionalParamsResp 企业版附加参数信息。
func (AdditionalParamsResp) String ¶
func (o AdditionalParamsResp) String() string
type BindInstanceTags ¶
type BindInstanceTags struct { // 实例标签 Tags []Tag `json:"tags"` }
func (BindInstanceTags) String ¶
func (o BindInstanceTags) String() string
type BindInstanceTagsRequest ¶
type BindInstanceTagsRequest struct { // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId string `json:"instance_id"` Body *BindInstanceTags `json:"body,omitempty"` }
BindInstanceTagsRequest Request Object
func (BindInstanceTagsRequest) String ¶
func (o BindInstanceTagsRequest) String() string
type BindInstanceTagsResponse ¶
type BindInstanceTagsResponse struct { Body *string `json:"body,omitempty"` HttpStatusCode int `json:"-"` }
BindInstanceTagsResponse Response Object
func (BindInstanceTagsResponse) String ¶
func (o BindInstanceTagsResponse) String() string
type ChangeInstanceChargeMode ¶
type ChangeInstanceChargeMode struct { // **参数说明**:订购设备接入实例的周期类型(包年、包月等)。charge_mode为prePaid时生效,且为必选值。 **取值范围**: - month:包月 - year:包年 PeriodType string `json:"period_type"` // **参数说明**:订购设备接入实例的周期数。charge_mode为prePaid时生效,且为必选值。 **取值范围**:period_type=month(周期类型为月)时,取值为[1,9];period_type=year(周期类型为年)时,取值为[1,3]\" PeriodNum int32 `json:"period_num"` // **参数说明**:创建包年/包月实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 **取值范围**: - true:自动续订 - false:默认值,不自动续订 IsAutoRenew *bool `json:"is_auto_renew,omitempty"` // **参数说明**:创建包年/包月实例时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 **取值范围**:true - 自动支付,从账户余额自动扣费; false - 默认值,只提交订单不支付。[需要客户参考[\"支付包年/包月产品订单\"](https://support.huaweicloud.com/api-bpconsole/api_order_00016.html#section0)进行支付,或者在华为云官网页面使用进行支付。](tag:hws) IsAutoPay *bool `json:"is_auto_pay,omitempty"` }
func (ChangeInstanceChargeMode) String ¶
func (o ChangeInstanceChargeMode) String() string
type ChangeInstanceChargeModeRequest ¶
type ChangeInstanceChargeModeRequest struct { // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId string `json:"instance_id"` Body *ChangeInstanceChargeMode `json:"body,omitempty"` }
ChangeInstanceChargeModeRequest Request Object
func (ChangeInstanceChargeModeRequest) String ¶
func (o ChangeInstanceChargeModeRequest) String() string
type ChangeInstanceChargeModeResponse ¶
type ChangeInstanceChargeModeResponse struct { // **参数说明**:订单号。[查看订单详情请参考[查询订单详情](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0075746564.html)。](tag:hws)\" OrderId *string `json:"order_id,omitempty"` HttpStatusCode int `json:"-"` }
ChangeInstanceChargeModeResponse Response Object
func (ChangeInstanceChargeModeResponse) String ¶
func (o ChangeInstanceChargeModeResponse) String() string
type ChargeInfo ¶
type ChargeInfo struct { // **参数说明**:实例的付费方式。 **取值范围**: - prePaid:包年/包月 - postPaid:按需计费 ChargeMode string `json:"charge_mode"` // **参数说明**:订购设备接入实例的周期类型(包年、包月等)。charge_mode为prePaid时生效,且为必选值。 **取值范围**: - month:包月 - year:包年 PeriodType *string `json:"period_type,omitempty"` // **参数说明**:订购设备接入实例的周期数。charge_mode为prePaid时生效,且为必选值。 **取值范围**:period_type=month(周期类型为月)时,取值为[1,9];period_type=year(周期类型为年)时,取值为[1,3]\" PeriodNum *int32 `json:"period_num,omitempty"` // **参数说明**:创建包年/包月实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 **取值范围**: - true:自动续订 - false:默认值,不自动续订 IsAutoRenew *bool `json:"is_auto_renew,omitempty"` // **参数说明**:创建包年/包月实例时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 **取值范围**:true - 自动支付,从账户余额自动扣费; false - 默认值,只提交订单不支付。[需要客户参考[\"支付包年/包月产品订单\"](https://support.huaweicloud.com/api-bpconsole/api_order_00016.html#section0)进行支付,或者在华为云官网页面使用进行支付。](tag:hws) IsAutoPay *bool `json:"is_auto_pay,omitempty"` }
ChargeInfo **参数说明**:设备接入实例计费信息
func (ChargeInfo) String ¶
func (o ChargeInfo) String() string
type CreateInstance ¶
type CreateInstance struct { // **参数说明**:创建的实例类型。实例类型说明参见[[产品规格说明](https://support.huaweicloud.com/productdesc-iothub/iot_04_0014.html)](tag:hws)[[产品规格说明](https://support.huaweicloud.com/intl/zh-cn/productdesc-iothub/iot_04_0014.html)](tag:hws_hk)。 **取值范围**: - standard:标准版实例 - enterprise:企业版实例 InstanceType string `json:"instance_type"` Flavor *Flavor `json:"flavor"` // **参数说明**:实例名称 **取值范围**:由中文字符,英文字母、数字及“_”、“-”组成,且长度为[1-64]个字符。 Name string `json:"name"` ChargeInfo *ChargeInfo `json:"charge_info"` // **参数说明**:设备接入实例的描述信息。 **取值范围**:由中文,字母,数字,句号,逗号,下划线(“_”),中划线(“-”),空格组成,且长度为[1-256]个字符。 Description *string `json:"description,omitempty"` // **参数说明**:企业项目Id。此字段填写明确的企业项目Id或者0(表示默认企业项目Id)时支持企业项目特性。可以企业项目管理服务中获取。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 EnterpriseProjectId *string `json:"enterprise_project_id,omitempty"` // **参数说明**:设备接入实例的标签信息。 Tags *[]Tag `json:"tags,omitempty"` AdditionalParams *AdditionalParams `json:"additional_params,omitempty"` }
func (CreateInstance) String ¶
func (o CreateInstance) String() string
type CreateInstanceRequest ¶
type CreateInstanceRequest struct {
Body *CreateInstance `json:"body,omitempty"`
}
CreateInstanceRequest Request Object
func (CreateInstanceRequest) String ¶
func (o CreateInstanceRequest) String() string
type CreateInstanceResponse ¶
type CreateInstanceResponse struct { // **参数说明**:实例类型。 **取值范围**: - standard:标准版实例 - enterprise:企业版实例 InstanceType *string `json:"instance_type,omitempty"` // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId *string `json:"instance_id,omitempty"` // **参数说明**:实例名称 **取值范围**:由中文字符,英文字母、数字及“_”、“-”组成,且长度为[1-64]个字符。 Name *string `json:"name,omitempty"` Flavor *Flavor `json:"flavor,omitempty"` // **参数说明**:实例状态。 **取值范围**: - CREATING:实例正在创建 - ACTIVE:实例正常 - FROZEN:实例冻结 - MODIFYING:实例正在变更规格 - FAILED:实例创建失败 Status *string `json:"status,omitempty"` ChargeInfo *ChargeInfo `json:"charge_info,omitempty"` // **参数说明**:设备接入实例的描述信息。 **取值范围**:由中文,字母,数字,句号,逗号,下划线(“_”),中划线(“-”),空格组成,且长度为[0-256]个字符。 Description *string `json:"description,omitempty"` // **参数说明**:企业项目Id。 EnterpriseProjectId *string `json:"enterprise_project_id,omitempty"` // **参数说明**: 设备接入实例的标签信息。如果实例有标签,则会有该字段,否则该字段为空。 Tags *[]Tag `json:"tags,omitempty"` // **参数说明**:订单号,创建包年包月实例时返回该参数。[查看订单详情请参考[查询订单详情](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0075746564.html)。](tag:hws)\" OrderId *string `json:"order_id,omitempty"` AdditionalParams *AdditionalParams `json:"additional_params,omitempty"` HttpStatusCode int `json:"-"` }
CreateInstanceResponse Response Object
func (CreateInstanceResponse) String ¶
func (o CreateInstanceResponse) String() string
type DeleteInstanceRequest ¶
type DeleteInstanceRequest struct { // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId string `json:"instance_id"` }
DeleteInstanceRequest Request Object
func (DeleteInstanceRequest) String ¶
func (o DeleteInstanceRequest) String() string
type DeleteInstanceResponse ¶
type DeleteInstanceResponse struct { Body *string `json:"body,omitempty"` HttpStatusCode int `json:"-"` }
DeleteInstanceResponse Response Object
func (DeleteInstanceResponse) String ¶
func (o DeleteInstanceResponse) String() string
type Flavor ¶
type Flavor struct { // **参数说明**:待创建设备接入实例的规格名称。详情请参见[[产品规格说明](https://support.huaweicloud.com/productdesc-iothub/iot_04_0014.html)](tag:hws)[[产品规格说明](https://support.huaweicloud.com/intl/zh-cn/productdesc-iothub/iot_04_0014.html)](tag:hws_hk)中的规格编码。 Type string `json:"type"` // **参数说明**:待创建设备接入标准版实例的单元数量。详情请参见[[产品规格说明](https://support.huaweicloud.com/productdesc-iothub/iot_04_0014.html)](tag:hws)[[产品规格说明](https://support.huaweicloud.com/intl/zh-cn/productdesc-iothub/iot_04_0014.html)](tag:hws_hk)。当instance_type是standard时,该参数必填。 Size *int32 `json:"size,omitempty"` }
Flavor **参数说明**:设备接入实例的规格参数。
type ForwardingInfo ¶
type ForwardingInfo struct { // **参数说明**:NAT网关绑定的EIP Eip *string `json:"eip,omitempty"` // **参数说明**:是否启用SNAT配置 **取值范围**: - true: SNAT配置已启用 - false: SNAT配置未启用 EnableSnat *bool `json:"enable_snat,omitempty"` }
ForwardingInfo 企业版实例的SNAT配置信息。
func (ForwardingInfo) String ¶
func (o ForwardingInfo) String() string
type IpAllowList ¶
type IpAllowList struct { // **参数说明**:白名单ip地址 Address string `json:"address"` // **参数说明**:描述 Description *string `json:"description,omitempty"` }
func (IpAllowList) String ¶
func (o IpAllowList) String() string
type IpWhiteList ¶
type IpWhiteList struct { // **参数说明**:启用Ip白名单访问控制 Enable bool `json:"enable"` // 允许访问企业版实例的IP地址列表 AllowList *[]IpAllowList `json:"allow_list,omitempty"` }
IpWhiteList IP白名单 约束:只有企业版实例的APP_HTTPS协议支持配置IP白名单。
func (IpWhiteList) String ¶
func (o IpWhiteList) String() string
type ListInstancesRequest ¶
type ListInstancesRequest struct { // **参数说明**:表示从marker后偏移offset条记录开始查询。默认为0,取值范围为0-500的整数。当offset为0时,表示从marker后第一条记录开始输出。 - 限制offset最大值是出于API性能考虑,您可以搭配marker使用该参数实现翻页,例如每页50条记录,1-11页内都可以直接使用offset跳转到指定页,但到11页后,由于offset限制为500,您需要使用第11页返回的marker作为下次查询的marker,以实现翻页到12-22页。 取值范围:0-500的整数,默认为0。 Offset *int32 `json:"offset,omitempty"` // **参数说明**:分页查询时每页显示的记录数。 **取值范围**:1-500的整数,默认为500。 Limit *int32 `json:"limit,omitempty"` // 上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marker的数据记录。若不填写,则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据,则每次查询时必须填写上一次查询响应中的marker值。 Marker *string `json:"marker,omitempty"` // **参数说明**:设备接入实例名称,匹配规则为模糊匹配。 **取值范围**:由中文字符,英文字母、数字及“_”、“-”组成,且长度为[1-64]个字符。 Name *string `json:"name,omitempty"` // **参数说明**:实例类型。 **取值范围**: - standard:标准版实例 - enterprise:企业版实例 InstanceType *string `json:"instance_type,omitempty"` }
ListInstancesRequest Request Object
func (ListInstancesRequest) String ¶
func (o ListInstancesRequest) String() string
type ListInstancesResponse ¶
type ListInstancesResponse struct { // 设备接入实例的总数 Count *int32 `json:"count,omitempty"` // 本次分页查询结果中最后一条记录的ID,可在下一次分页查询时使用 Marker *string `json:"marker,omitempty"` // 设备接入实例的详情列表 Instances *[]QueryInstanceSimplify `json:"instances,omitempty"` HttpStatusCode int `json:"-"` }
ListInstancesResponse Response Object
func (ListInstancesResponse) String ¶
func (o ListInstancesResponse) String() string
type OperateWindow ¶
type OperateWindow struct { // **参数说明**:变更时间窗开始时间,UTC时间,格式为:\"HH:mm\" StartTime string `json:"start_time"` // **参数说明**:变更时间窗结束时间,UTC时间,格式为:\"HH:mm\" EndTime string `json:"end_time"` }
OperateWindow 实例维护时间窗,用户在变更实例规格时,可以指定在该时间窗内进行变更。
func (OperateWindow) String ¶
func (o OperateWindow) String() string
type Port ¶
type Port struct { // **参数说明**:应用接入HTTPS协议端口,默认值:443 AppHttpsPort *int32 `json:"app_https_port,omitempty"` // **参数说明**:应用接入AMQP协议端口, 默认值:5671 AppAmqpsPort *int32 `json:"app_amqps_port,omitempty"` // **参数说明**:设备接入COAP协议端口, 默认值:5683 DeviceCoapPort *int32 `json:"device_coap_port,omitempty"` // **参数说明**:设备接入COAPS协议端口, 默认值:5684 DeviceCoapsPort *int32 `json:"device_coaps_port,omitempty"` // **参数说明**:设备接入MQTT协议端口, 默认值:1883 DeviceMqttPort *int32 `json:"device_mqtt_port,omitempty"` // **参数说明**:设备接入MQTTS协议端口, 默认值:8883 DeviceMqttsPort *int32 `json:"device_mqtts_port,omitempty"` // **参数说明**:设备接入HTTPS协议端口, 默认值:443 DeviceHttpsPort *int32 `json:"device_https_port,omitempty"` }
Port 企业版端口信息。创建企业版实例时必填。
type QueryInstanceSimplify ¶
type QueryInstanceSimplify struct { // **参数说明**:实例类型。 **取值范围**: - standard:标准版实例 - enterprise:企业版实例 InstanceType *string `json:"instance_type,omitempty"` // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId *string `json:"instance_id,omitempty"` // **参数说明**:实例名称 **取值范围**:由中文字符,英文字母、数字及“_”、“-”组成,且长度为[1-64]个字符。 Name *string `json:"name,omitempty"` // **参数说明**:实例的付费方式。 **取值范围**: - prePaid:包年/包月 - postPaid:按需计费 ChargeMode *string `json:"charge_mode,omitempty"` Flavor *Flavor `json:"flavor,omitempty"` // **参数说明**:实例状态。 **取值范围**: - CREATING:实例正在创建 - ACTIVE:实例正常 - FROZEN:实例冻结 - MODIFYING:实例正在变更规格 - FAILED:实例创建失败 Status *string `json:"status,omitempty"` // **参数说明**:实例的创建时间。时间格式例如:2023-01-28T06:57:52Z CreateTime *string `json:"create_time,omitempty"` // **参数说明**:实例的最近一次更新的时间。时间格式例如:2023-01-28T06:57:52Z UpdateTime *string `json:"update_time,omitempty"` // **参数说明**:企业项目Id。 EnterpriseProjectId *string `json:"enterprise_project_id,omitempty"` }
func (QueryInstanceSimplify) String ¶
func (o QueryInstanceSimplify) String() string
type ResizeInstance ¶
type ResizeInstance struct { Flavor *Flavor `json:"flavor"` // **参数说明**:修改包年/包月实例的规格时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 **取值范围**:true - 自动支付,从账户余额自动扣费; false - 默认值,只提交订单不支付。[需要客户参考[\"支付包年/包月产品订单\"](https://support.huaweicloud.com/api-bpconsole/api_order_00016.html#section0)进行支付,或者在华为云官网页面使用进行支付。](tag:hws) IsAutoPay *bool `json:"is_auto_pay,omitempty"` // **参数说明**:是否延时变更设备实例的计费信息。约束:如需延时变更,需要先设置实例的变更时间窗。 **取值范围**: - true:延迟变更,规格变更任务将在指定的变更时间窗内执行。 - false:立即变更,规格变更任务将立即执行。 Delay *bool `json:"delay,omitempty"` }
func (ResizeInstance) String ¶
func (o ResizeInstance) String() string
type ResizeInstanceRequest ¶
type ResizeInstanceRequest struct { // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId string `json:"instance_id"` Body *ResizeInstance `json:"body,omitempty"` }
ResizeInstanceRequest Request Object
func (ResizeInstanceRequest) String ¶
func (o ResizeInstanceRequest) String() string
type ResizeInstanceResponse ¶
type ResizeInstanceResponse struct { // **参数说明**:订单号,修改包年包月实例时返回该参数,修改按需实例时返回为空。查看订单详情请参考[[查询订单详情](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0075746564.html)]\" OrderId *string `json:"order_id,omitempty"` HttpStatusCode int `json:"-"` }
ResizeInstanceResponse Response Object
func (ResizeInstanceResponse) String ¶
func (o ResizeInstanceResponse) String() string
type ShowInstanceRequest ¶
type ShowInstanceRequest struct { // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId string `json:"instance_id"` }
ShowInstanceRequest Request Object
func (ShowInstanceRequest) String ¶
func (o ShowInstanceRequest) String() string
type ShowInstanceResponse ¶
type ShowInstanceResponse struct { // **参数说明**:实例类型。 **取值范围**: - standard:标准版实例 - enterprise:企业版实例 InstanceType *string `json:"instance_type,omitempty"` // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId *string `json:"instance_id,omitempty"` // **参数说明**:实例的付费方式。 **取值范围**: - prePaid:包年/包月 - postPaid:按需计费 ChargeMode *string `json:"charge_mode,omitempty"` // **参数说明**:实例名称 **取值范围**:由中文字符,英文字母、数字及“_”、“-”组成,且长度为[1-64]个字符。 Name *string `json:"name,omitempty"` Flavor *Flavor `json:"flavor,omitempty"` // **参数说明**:实例状态。 **取值范围**: - CREATING:实例正在创建 - ACTIVE:实例正常 - FROZEN:实例冻结 - MODIFYING:实例正在变更规格 - FAILED:实例创建失败 Status *string `json:"status,omitempty"` // **参数说明**:设备接入实例的描述信息。 **取值范围**:由中文,字母,数字,句号,逗号,下划线(“_”),中划线(“-”),空格组成,且长度为[1-256]个字符。 Description *string `json:"description,omitempty"` // **参数说明**:设备接入实例的接入信息 AccessInfos *[]AccessInfo `json:"access_infos,omitempty"` // **参数说明**:实例的创建时间。时间格式例如:2023-01-28T06:57:52Z CreateTime *string `json:"create_time,omitempty"` // **参数说明**:实例的最近一次更新的时间。时间格式例如:2023-01-28T06:57:52Z UpdateTime *string `json:"update_time,omitempty"` // **参数说明**:企业项目Id。 EnterpriseProjectId *string `json:"enterprise_project_id,omitempty"` // **参数说明**: 设备接入实例的标签信息。如果实例有标签,则会有该字段,否则该字段为空。 Tags *[]Tag `json:"tags,omitempty"` // **参数说明**:订单号,仅包年包月实例返回该参数。[查看订单详情请参考[[查询订单详情](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0075746564.html)。]](tag:hws) OrderId *string `json:"order_id,omitempty"` OperateWindow *OperateWindow `json:"operate_window,omitempty"` AdditionalParams *AdditionalParamsResp `json:"additional_params,omitempty"` HttpStatusCode int `json:"-"` }
ShowInstanceResponse Response Object
func (ShowInstanceResponse) String ¶
func (o ShowInstanceResponse) String() string
type Tag ¶
type UnbindInstanceTags ¶
type UnbindInstanceTags struct { // 实例标签 Tags []Tag `json:"tags"` }
func (UnbindInstanceTags) String ¶
func (o UnbindInstanceTags) String() string
type UnbindInstanceTagsRequest ¶
type UnbindInstanceTagsRequest struct { // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId string `json:"instance_id"` Body *UnbindInstanceTags `json:"body,omitempty"` }
UnbindInstanceTagsRequest Request Object
func (UnbindInstanceTagsRequest) String ¶
func (o UnbindInstanceTagsRequest) String() string
type UnbindInstanceTagsResponse ¶
type UnbindInstanceTagsResponse struct { Body *string `json:"body,omitempty"` HttpStatusCode int `json:"-"` }
UnbindInstanceTagsResponse Response Object
func (UnbindInstanceTagsResponse) String ¶
func (o UnbindInstanceTagsResponse) String() string
type UpdateAccessInfo ¶
type UpdateAccessInfo struct { // **参数说明**:接入地址的类型,如应用接入的HTTPS协议的取值为:APP_HTTPS,设备接入的MQTT协议的取值为:DEVICE_MQTT **取值范围**: - APP_HTTPS:应用接入HTTPS协议 - APP_AMQP:应用接入AMQP协议 - APP_MQTT:应用接入MQTT协议 - DEVICE_COAP:设备接入COAP协议 - DEVICE_MQTT:设备接入MQTT协议 - DEVICE_HTTPS:设备接入HTTPS协议 AccessType string `json:"access_type"` // **参数说明**:接入域名,如果需要更新域名,则携带该字段。 DomainName *string `json:"domain_name,omitempty"` // **参数说明**:是否配置公网接入地址,true,false **取值范围**: - true:配置公网接入地址,平台将自动分配公网接入地址。约束:分配地址后将不能修改或删除。 PublicAddressesEnable *bool `json:"public_addresses_enable,omitempty"` IpWhitelist *IpWhiteList `json:"ip_whitelist,omitempty"` }
UpdateAccessInfo 设备接入实例的接入信息。用户可以使用该结构体中的信息将应用服务器和设备接入到物联网平台。 约束:只有企业版实例支持自定义接入信息。
func (UpdateAccessInfo) String ¶
func (o UpdateAccessInfo) String() string
type UpdateForwardingInfo ¶
type UpdateForwardingInfo struct { // **参数说明**:是否启用SNAT配置。企业版实例开启SNAT配置后,可以在公共网络中进行外部通信。 约束:只有企业版实例支持配置SNAT配置,SNAT配置开启后将不支持关闭 **取值范围**: - true: 启用SNAT配置 EnableSnat bool `json:"enable_snat"` }
UpdateForwardingInfo 企业版实例的SNAT配置,配置开启后,企业版实例可以在公共网络中进行外部通信。 约束:只有企业版实例支持修改流转配置。
func (UpdateForwardingInfo) String ¶
func (o UpdateForwardingInfo) String() string
type UpdateInstance ¶
type UpdateInstance struct { // **参数说明**:实例名称 **取值范围**:由中文字符,英文字母、数字及“_”、“-”组成,且长度为[1-64]个字符。 Name *string `json:"name,omitempty"` // **参数说明**:设备接入实例的描述信息。 **取值范围**:由中文,字母,数字,句号,逗号,下划线(“_”),中划线(“-”),空格组成,且长度为[1-256]个字符。 Description *string `json:"description,omitempty"` OperateWindow *OperateWindow `json:"operate_window,omitempty"` ForwardingInfo *UpdateForwardingInfo `json:"forwarding_info,omitempty"` AccessInfo *UpdateAccessInfo `json:"access_info,omitempty"` }
func (UpdateInstance) String ¶
func (o UpdateInstance) String() string
type UpdateInstanceRequest ¶
type UpdateInstanceRequest struct { // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId string `json:"instance_id"` Body *UpdateInstance `json:"body,omitempty"` }
UpdateInstanceRequest Request Object
func (UpdateInstanceRequest) String ¶
func (o UpdateInstanceRequest) String() string
type UpdateInstanceResponse ¶
type UpdateInstanceResponse struct { // **参数说明**:实例类型。 **取值范围**: - standard:标准版实例 - enterprise:企业版实例 InstanceType *string `json:"instance_type,omitempty"` // **参数说明**:实例ID。 **取值范围**:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 InstanceId *string `json:"instance_id,omitempty"` // **参数说明**:实例的付费方式。 **取值范围**: - prePaid:包年/包月 - postPaid:按需计费 ChargeMode *string `json:"charge_mode,omitempty"` // **参数说明**:实例名称 **取值范围**:由中文字符,英文字母、数字及“_”、“-”组成,且长度为[1-64]个字符。 Name *string `json:"name,omitempty"` Flavor *Flavor `json:"flavor,omitempty"` // **参数说明**:实例状态。 **取值范围**: - CREATING:实例正在创建 - ACTIVE:实例正常 - FROZEN:实例冻结 - MODIFYING:实例正在变更规格 - FAILED:实例创建失败 Status *string `json:"status,omitempty"` // **参数说明**:设备接入实例的描述信息。 **取值范围**:由中文,字母,数字,句号,逗号,下划线(“_”),中划线(“-”),空格组成,且长度为[1-256]个字符。 Description *string `json:"description,omitempty"` // **参数说明**:设备接入实例的接入信息 AccessInfos *[]AccessInfo `json:"access_infos,omitempty"` // **参数说明**:实例的创建时间。时间格式例如:2023-01-28T06:57:52Z CreateTime *string `json:"create_time,omitempty"` // **参数说明**:实例的最近一次更新的时间。时间格式例如:2023-01-28T06:57:52Z UpdateTime *string `json:"update_time,omitempty"` // **参数说明**:企业项目Id。 EnterpriseProjectId *string `json:"enterprise_project_id,omitempty"` // **参数说明**: 设备接入实例的标签信息。如果实例有标签,则会有该字段,否则该字段为空。 Tags *[]Tag `json:"tags,omitempty"` // **参数说明**:订单号,仅包年包月实例返回该参数。[查看订单详情请参考[[查询订单详情](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0075746564.html)。]](tag:hws) OrderId *string `json:"order_id,omitempty"` OperateWindow *OperateWindow `json:"operate_window,omitempty"` AdditionalParams *AdditionalParamsResp `json:"additional_params,omitempty"` HttpStatusCode int `json:"-"` }
UpdateInstanceResponse Response Object
func (UpdateInstanceResponse) String ¶
func (o UpdateInstanceResponse) String() string
Source Files ¶
- model_access_info.go
- model_additional_params.go
- model_additional_params_resp.go
- model_bind_instance_tags.go
- model_bind_instance_tags_request.go
- model_bind_instance_tags_response.go
- model_change_instance_charge_mode.go
- model_change_instance_charge_mode_request.go
- model_change_instance_charge_mode_response.go
- model_charge_info.go
- model_create_instance.go
- model_create_instance_request.go
- model_create_instance_response.go
- model_delete_instance_request.go
- model_delete_instance_response.go
- model_flavor.go
- model_forwarding_info.go
- model_ip_allow_list.go
- model_ip_white_list.go
- model_list_instances_request.go
- model_list_instances_response.go
- model_operate_window.go
- model_port.go
- model_query_instance_simplify.go
- model_resize_instance.go
- model_resize_instance_request.go
- model_resize_instance_response.go
- model_show_instance_request.go
- model_show_instance_response.go
- model_tag.go
- model_unbind_instance_tags.go
- model_unbind_instance_tags_request.go
- model_unbind_instance_tags_response.go
- model_update_access_info.go
- model_update_forwarding_info.go
- model_update_instance.go
- model_update_instance_request.go
- model_update_instance_response.go