ugn

package
v0.22.2 Latest Latest
Warning

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

 Go to latest Published: May 6, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package ugn include resources of ucloud ugn product

See also

for detail.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttachUGNInstanceRequest 

type AttachUGNInstanceRequest struct {
	request.CommonBase

	// 实例Id
	InstanceId *string `required:"true"`

	// 实例归属ProjectId
	InstanceProjectId *string `required:"true"`

	// 实例归属地域
	InstanceRegion *string `required:"true"`

	// 实例类型
	InstanceType *string `required:"true"`

	// 云联网Id
	UGNId *string `required:"true"`
}

AttachUGNInstanceRequest is request schema for AttachUGNInstance action

type AttachUGNInstanceResponse 

type AttachUGNInstanceResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string
}

AttachUGNInstanceResponse is response schema for AttachUGNInstance action

type BatchDetachUGNInstanceRequest 

type BatchDetachUGNInstanceRequest struct {
	request.CommonBase

	// 实例id
	InstanceIds []string `required:"true"`

	// 云联网id
	UGNId *string `required:"true"`
}

BatchDetachUGNInstanceRequest is request schema for BatchDetachUGNInstance action

type BatchDetachUGNInstanceResponse 

type BatchDetachUGNInstanceResponse struct {
	response.CommonBase

	// 删除成功的实例id
	InstanceIds []string
}

BatchDetachUGNInstanceResponse is response schema for BatchDetachUGNInstance action

type CreateInterRegionBandwidthRequest 

type CreateInterRegionBandwidthRequest struct {
	request.CommonBase

	// 带宽（单位为Mb/s）
	Bandwidth *int `required:"true"`

	// 计费类型
	ChargeType *string `required:"true"`

	// 代金券Id
	CouponId *string `required:"false"`

	// 付费类型
	PayMode *string `required:"true"`

	// 购买时长
	Quantity *int `required:"true"`

	// 跨域带宽归属地域
	Region0 *string `required:"true"`

	// 跨域带宽归属地域
	Region1 *string `required:"true"`

	// 云联网Id
	UGNId *string `required:"true"`
}

CreateInterRegionBandwidthRequest is request schema for CreateInterRegionBandwidth action

type CreateInterRegionBandwidthResponse 

type CreateInterRegionBandwidthResponse struct {
	response.CommonBase

	// 跨域带宽Id
	InterRegionBandwidthId string

	// 返回码描述信息
	Message string
}

CreateInterRegionBandwidthResponse is response schema for CreateInterRegionBandwidth action

type CreateUGNRequest 

type CreateUGNRequest struct {
	request.CommonBase

	// 云联网名称，如果没有传入，默认值为“UGN”
	Name *string `required:"false"`

	// 云联网备注，如果没有传入的话，默认为“”
	Remark *string `required:"false"`

	// 业务组Id，如果没有传入，默认值为“Default”
	Tag *string `required:"false"`
}

CreateUGNRequest is request schema for CreateUGN action

type CreateUGNResponse 

type CreateUGNResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string

	// 云联网Id
	UGNId string
}

CreateUGNResponse is response schema for CreateUGN action

type DeleteInterRegionBandwidthRequest 

type DeleteInterRegionBandwidthRequest struct {
	request.CommonBase

	// 跨域带宽Id
	InterRegionBandwidthId *string `required:"true"`

	// 云联网Id
	UGNId *string `required:"true"`
}

DeleteInterRegionBandwidthRequest is request schema for DeleteInterRegionBandwidth action

type DeleteInterRegionBandwidthResponse 

type DeleteInterRegionBandwidthResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string
}

DeleteInterRegionBandwidthResponse is response schema for DeleteInterRegionBandwidth action

type DeleteUGNRequest 

type DeleteUGNRequest struct {
	request.CommonBase

	// 云联网Id
	UGNId *string `required:"true"`
}

DeleteUGNRequest is request schema for DeleteUGN action

type DeleteUGNResponse 

type DeleteUGNResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string
}

DeleteUGNResponse is response schema for DeleteUGN action

type DescribeInterRegionBandwidthRequest 

type DescribeInterRegionBandwidthRequest struct {
	request.CommonBase

	// 跨域带宽Id
	InterRegionBandwidthIds []string `required:"false"`

	// 数据分页值。默认为20
	Limit *int `required:"false"`

	// 数据偏移量。默认为0
	Offset *int `required:"false"`

	// 云联网Id
	UGNId *string `required:"true"`
}

DescribeInterRegionBandwidthRequest is request schema for DescribeInterRegionBandwidth action

type DescribeInterRegionBandwidthResponse 

type DescribeInterRegionBandwidthResponse struct {
	response.CommonBase

	// 跨域带宽信息
	InterRegionBandwidths []InterRegionBandwidth

	// 返回码描述信息
	Message string

	// InterRegionBandwidths字段的数量
	TotalCount int
}

DescribeInterRegionBandwidthResponse is response schema for DescribeInterRegionBandwidth action

type DescribeUGNInstanceRequest 

type DescribeUGNInstanceRequest struct {
	request.CommonBase

	// 实例Id
	InstanceIds []string `required:"false"`

	// 数据分页值。默认为20
	Limit *int `required:"false"`

	// 数据偏移量。默认为0
	Offset *int `required:"false"`

	// 云联网Id
	UGNId *string `required:"true"`
}

DescribeUGNInstanceRequest is request schema for DescribeUGNInstance action

type DescribeUGNInstanceResponse 

type DescribeUGNInstanceResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string

	// UGNInstances字段的数量
	TotalCount int

	// 实例信息
	UGNInstances []Instance
}

DescribeUGNInstanceResponse is response schema for DescribeUGNInstance action

type DescribeUGNRegionListRequest 

type DescribeUGNRegionListRequest struct {
	request.CommonBase
}

DescribeUGNRegionListRequest is request schema for DescribeUGNRegionList action

type DescribeUGNRegionListResponse 

type DescribeUGNRegionListResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string

	// 地域列表
	RegionList []string
}

DescribeUGNRegionListResponse is response schema for DescribeUGNRegionList action

type DescribeUGNRequest 

type DescribeUGNRequest struct {
	request.CommonBase

	// 数据分页值。默认为20
	Limit *int `required:"false"`

	// 数据偏移量。默认为0
	Offset *int `required:"false"`

	// 云联网Id
	UGNIds []string `required:"false"`
}

DescribeUGNRequest is request schema for DescribeUGN action

type DescribeUGNResponse 

type DescribeUGNResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string

	// UGNs字段的数量
	TotalCount int

	// 云联网信息
	UGNs []UGN
}

DescribeUGNResponse is response schema for DescribeUGN action

type DescribeUGNRouteRuleRequest 

type DescribeUGNRouteRuleRequest struct {
	request.CommonBase

	// 数据分页值。默认为20
	Limit *int `required:"false"`

	// 数据偏移量。默认为0
	Offset *int `required:"false"`

	// 路由规则Id
	RouteRuleIds []string `required:"false"`

	// 云联网Id
	UGNId *string `required:"true"`
}

DescribeUGNRouteRuleRequest is request schema for DescribeUGNRouteRule action

type DescribeUGNRouteRuleResponse 

type DescribeUGNRouteRuleResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string

	// UGNRouteRules字段的数量
	TotalCount int

	// 路由规则信息
	UGNRouteRules []RouteRule
}

DescribeUGNRouteRuleResponse is response schema for DescribeUGNRouteRule action

type DetachUGNInstanceRequest 

type DetachUGNInstanceRequest struct {
	request.CommonBase

	// 实例Id
	InstanceId *string `required:"true"`

	// 实例类型
	InstanceType *string `required:"true"`

	// 云联网Id
	UGNId *string `required:"true"`
}

DetachUGNInstanceRequest is request schema for DetachUGNInstance action

type DetachUGNInstanceResponse 

type DetachUGNInstanceResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string
}

DetachUGNInstanceResponse is response schema for DetachUGNInstance action

type Instance 

type Instance struct {

	// 加入时间
	CreateTime int

	// 实例Id
	InstanceId string

	// 实例归属项目名称
	InstanceOrganizationName string

	// 实例归属ProjectId
	InstanceProjectId string

	// 实例归属地域
	InstanceRegion string

	// 实例类型
	InstanceType string

	// 网段信息
	Networks []string

	// 实例状态
	State int

	// 云联网Id
	UGNId string
}

Instance - 云联网实例信息

type InterRegionBandwidth 

type InterRegionBandwidth struct {

	// 带宽（单位为Mb/s）
	Bandwidth int

	// 计费类型
	ChargeType string

	// 创建时间
	CreateTime int

	// 到期时间
	ExpireTime int

	// 跨域带宽Id
	InterRegionBandwidthId string

	// 付费类型
	PayMode string

	// 跨域带宽地域
	Region0 string

	// 跨域带宽地域
	Region1 string

	// 跨域带宽状态
	State int

	// 云联网Id
	UGNId string
}

InterRegionBandwidth - 跨域带宽

type ModifyInterRegionBandwidthRequest 

type ModifyInterRegionBandwidthRequest struct {
	request.CommonBase

	// 带宽（单位为Mb/s）
	Bandwidth *string `required:"true"`

	// 跨域带宽Id
	InterRegionBandwidthId *string `required:"true"`

	// 付费类型
	PayMode *string `required:"false"`

	// 云联网Id
	UGNId *string `required:"true"`
}

ModifyInterRegionBandwidthRequest is request schema for ModifyInterRegionBandwidth action

type ModifyInterRegionBandwidthResponse 

type ModifyInterRegionBandwidthResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string
}

ModifyInterRegionBandwidthResponse is response schema for ModifyInterRegionBandwidth action

type ModifyUGNAttributeRequest 

type ModifyUGNAttributeRequest struct {
	request.CommonBase

	// 云联网名称
	Name *string `required:"false"`

	// 云联网备注
	Remark *string `required:"false"`

	// 云联网Id
	UGNId *string `required:"true"`
}

ModifyUGNAttributeRequest is request schema for ModifyUGNAttribute action

type ModifyUGNAttributeResponse 

type ModifyUGNAttributeResponse struct {
	response.CommonBase

	// 错误码描述信息
	Message string
}

ModifyUGNAttributeResponse is response schema for ModifyUGNAttribute action

type PublishUGNRouteRuleRequest 

type PublishUGNRouteRuleRequest struct {
	request.CommonBase

	// 归属实例路由规则Id
	DeriveRouteRuleId *string `required:"true"`

	// 归属实例路由表Id
	DeriveRouteTableId *string `required:"true"`

	// 实例Id
	InstanceId *string `required:"true"`

	// 云联网Id
	UGNId *string `required:"true"`
}

PublishUGNRouteRuleRequest is request schema for PublishUGNRouteRule action

type PublishUGNRouteRuleResponse 

type PublishUGNRouteRuleResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string

	// 路由规则Id
	RouteRuleId string
}

PublishUGNRouteRuleResponse is response schema for PublishUGNRouteRule action

type RouteRule 

type RouteRule struct {

	// 创建时间
	CreateTime int

	// 归属实例Id
	DeriveInstanceId string

	// 归属实例地域
	DeriveInstanceRegion string

	// 归属实例类型
	DeriveInstanceType string

	// 归属实例路由规则Id
	DeriveRouteRuleId string

	// 归属实例路由表Id
	DeriveRouteTableId string

	// 目的地址
	DstAddr string

	// false:未使能true:已使能
	Enable bool

	// 归属实例路由下一跳
	NextHopId string

	// 归属实例路由下一跳类型
	NextHopType string

	// 优先级
	Priority int

	// false:不可撤回true:可撤回
	Rollback bool

	// 路由规则Id
	RouteRuleId string

	// 路由规则类型，枚举值 0：自动发布的LOCAL和动态路由1：手动发布的自定义路由
	RouteRuleType int
}

RouteRule - 云联网路由规则

type UGN 

type UGN struct {

	// 云联网创建时间
	CreateTime int

	// 实例Id
	Instances []string

	// 跨域路由Id
	InterRegionBandwidths []string

	// 云联网名称
	Name string

	// 云联网备注
	Remark string

	// 路由规则Id
	RouteRules []string

	// 业务组Id
	Tag string

	// 云联网Id
	UGNId string
}

UGN - 云联网信息

type UGNClient 

type UGNClient struct {
	*ucloud.Client
}

UGNClient is the client of UGN

func NewClient 

func NewClient(config *ucloud.Config, credential *auth.Credential) *UGNClient

NewClient will return a instance of UGNClient

func (*UGNClient) AttachUGNInstance 

func (c *UGNClient) AttachUGNInstance(req *AttachUGNInstanceRequest) (*AttachUGNInstanceResponse, error)

API: AttachUGNInstance

实例加入云联网

func (*UGNClient) BatchDetachUGNInstance 

func (c *UGNClient) BatchDetachUGNInstance(req *BatchDetachUGNInstanceRequest) (*BatchDetachUGNInstanceResponse, error)

API: BatchDetachUGNInstance

批量移除云联网中实例

func (*UGNClient) CreateInterRegionBandwidth 

func (c *UGNClient) CreateInterRegionBandwidth(req *CreateInterRegionBandwidthRequest) (*CreateInterRegionBandwidthResponse, error)

API: CreateInterRegionBandwidth

购买跨域带宽

func (*UGNClient) CreateUGN 

func (c *UGNClient) CreateUGN(req *CreateUGNRequest) (*CreateUGNResponse, error)

API: CreateUGN

创建云联网

func (*UGNClient) DeleteInterRegionBandwidth 

func (c *UGNClient) DeleteInterRegionBandwidth(req *DeleteInterRegionBandwidthRequest) (*DeleteInterRegionBandwidthResponse, error)

API: DeleteInterRegionBandwidth

删除跨域带宽

func (*UGNClient) DeleteUGN 

func (c *UGNClient) DeleteUGN(req *DeleteUGNRequest) (*DeleteUGNResponse, error)

API: DeleteUGN

删除云联网

func (*UGNClient) DescribeInterRegionBandwidth 

func (c *UGNClient) DescribeInterRegionBandwidth(req *DescribeInterRegionBandwidthRequest) (*DescribeInterRegionBandwidthResponse, error)

API: DescribeInterRegionBandwidth

查询跨域带宽

func (*UGNClient) DescribeUGN 

func (c *UGNClient) DescribeUGN(req *DescribeUGNRequest) (*DescribeUGNResponse, error)

API: DescribeUGN

查询云联网

func (*UGNClient) DescribeUGNInstance 

func (c *UGNClient) DescribeUGNInstance(req *DescribeUGNInstanceRequest) (*DescribeUGNInstanceResponse, error)

API: DescribeUGNInstance

查询云联网实例

func (*UGNClient) DescribeUGNRegionList 

func (c *UGNClient) DescribeUGNRegionList(req *DescribeUGNRegionListRequest) (*DescribeUGNRegionListResponse, error)

API: DescribeUGNRegionList

获取ugn支持的地域

func (*UGNClient) DescribeUGNRouteRule 

func (c *UGNClient) DescribeUGNRouteRule(req *DescribeUGNRouteRuleRequest) (*DescribeUGNRouteRuleResponse, error)

API: DescribeUGNRouteRule

查询路由规则

func (*UGNClient) DetachUGNInstance 

func (c *UGNClient) DetachUGNInstance(req *DetachUGNInstanceRequest) (*DetachUGNInstanceResponse, error)

API: DetachUGNInstance

实例退出云联网

func (*UGNClient) ModifyInterRegionBandwidth 

func (c *UGNClient) ModifyInterRegionBandwidth(req *ModifyInterRegionBandwidthRequest) (*ModifyInterRegionBandwidthResponse, error)

API: ModifyInterRegionBandwidth

修改跨域带宽

func (*UGNClient) ModifyUGNAttribute 

func (c *UGNClient) ModifyUGNAttribute(req *ModifyUGNAttributeRequest) (*ModifyUGNAttributeResponse, error)

API: ModifyUGNAttribute

修改云联网属性

func (*UGNClient) NewAttachUGNInstanceRequest 

func (c *UGNClient) NewAttachUGNInstanceRequest() *AttachUGNInstanceRequest

NewAttachUGNInstanceRequest will create request of AttachUGNInstance action.

func (*UGNClient) NewBatchDetachUGNInstanceRequest 

func (c *UGNClient) NewBatchDetachUGNInstanceRequest() *BatchDetachUGNInstanceRequest

NewBatchDetachUGNInstanceRequest will create request of BatchDetachUGNInstance action.

func (*UGNClient) NewCreateInterRegionBandwidthRequest 

func (c *UGNClient) NewCreateInterRegionBandwidthRequest() *CreateInterRegionBandwidthRequest

NewCreateInterRegionBandwidthRequest will create request of CreateInterRegionBandwidth action.

func (*UGNClient) NewCreateUGNRequest 

func (c *UGNClient) NewCreateUGNRequest() *CreateUGNRequest

NewCreateUGNRequest will create request of CreateUGN action.

func (*UGNClient) NewDeleteInterRegionBandwidthRequest 

func (c *UGNClient) NewDeleteInterRegionBandwidthRequest() *DeleteInterRegionBandwidthRequest

NewDeleteInterRegionBandwidthRequest will create request of DeleteInterRegionBandwidth action.

func (*UGNClient) NewDeleteUGNRequest 

func (c *UGNClient) NewDeleteUGNRequest() *DeleteUGNRequest

NewDeleteUGNRequest will create request of DeleteUGN action.

func (*UGNClient) NewDescribeInterRegionBandwidthRequest 

func (c *UGNClient) NewDescribeInterRegionBandwidthRequest() *DescribeInterRegionBandwidthRequest

NewDescribeInterRegionBandwidthRequest will create request of DescribeInterRegionBandwidth action.

func (*UGNClient) NewDescribeUGNInstanceRequest 

func (c *UGNClient) NewDescribeUGNInstanceRequest() *DescribeUGNInstanceRequest

NewDescribeUGNInstanceRequest will create request of DescribeUGNInstance action.

func (*UGNClient) NewDescribeUGNRegionListRequest 

func (c *UGNClient) NewDescribeUGNRegionListRequest() *DescribeUGNRegionListRequest

NewDescribeUGNRegionListRequest will create request of DescribeUGNRegionList action.

func (*UGNClient) NewDescribeUGNRequest 

func (c *UGNClient) NewDescribeUGNRequest() *DescribeUGNRequest

NewDescribeUGNRequest will create request of DescribeUGN action.

func (*UGNClient) NewDescribeUGNRouteRuleRequest 

func (c *UGNClient) NewDescribeUGNRouteRuleRequest() *DescribeUGNRouteRuleRequest

NewDescribeUGNRouteRuleRequest will create request of DescribeUGNRouteRule action.

func (*UGNClient) NewDetachUGNInstanceRequest 

func (c *UGNClient) NewDetachUGNInstanceRequest() *DetachUGNInstanceRequest

NewDetachUGNInstanceRequest will create request of DetachUGNInstance action.

func (*UGNClient) NewModifyInterRegionBandwidthRequest 

func (c *UGNClient) NewModifyInterRegionBandwidthRequest() *ModifyInterRegionBandwidthRequest

NewModifyInterRegionBandwidthRequest will create request of ModifyInterRegionBandwidth action.

func (*UGNClient) NewModifyUGNAttributeRequest 

func (c *UGNClient) NewModifyUGNAttributeRequest() *ModifyUGNAttributeRequest

NewModifyUGNAttributeRequest will create request of ModifyUGNAttribute action.

func (*UGNClient) NewPublishUGNRouteRuleRequest 

func (c *UGNClient) NewPublishUGNRouteRuleRequest() *PublishUGNRouteRuleRequest

NewPublishUGNRouteRuleRequest will create request of PublishUGNRouteRule action.

func (*UGNClient) NewUnpublishUGNRouteRuleRequest 

func (c *UGNClient) NewUnpublishUGNRouteRuleRequest() *UnpublishUGNRouteRuleRequest

NewUnpublishUGNRouteRuleRequest will create request of UnpublishUGNRouteRule action.

func (*UGNClient) PublishUGNRouteRule 

func (c *UGNClient) PublishUGNRouteRule(req *PublishUGNRouteRuleRequest) (*PublishUGNRouteRuleResponse, error)

API: PublishUGNRouteRule

发布云联网路由规则

func (*UGNClient) UnpublishUGNRouteRule 

func (c *UGNClient) UnpublishUGNRouteRule(req *UnpublishUGNRouteRuleRequest) (*UnpublishUGNRouteRuleResponse, error)

API: UnpublishUGNRouteRule

取消发布云联网路由规则

type UnpublishUGNRouteRuleRequest 

type UnpublishUGNRouteRuleRequest struct {
	request.CommonBase

	// 归属实例路由规则Id
	DeriveRouteRuleId *string `required:"true"`

	// 归属实例路由表Id
	DeriveRouteTableId *string `required:"true"`

	// 实例Id
	InstanceId *string `required:"true"`

	// 云联网Id
	UGNId *string `required:"true"`
}

UnpublishUGNRouteRuleRequest is request schema for UnpublishUGNRouteRule action

type UnpublishUGNRouteRuleResponse 

type UnpublishUGNRouteRuleResponse struct {
	response.CommonBase

	// 返回码描述信息
	Message string
}

UnpublishUGNRouteRuleResponse is response schema for UnpublishUGNRouteRule action

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.