Documentation
¶
Overview ¶
Package pathx include resources of ucloud pathx product
See also
- API: https://docs.ucloud.cn/api/pathx-api/index
- Product: https://www.ucloud.cn/site/product/pathx.html
for detail.
Index ¶
- type CreateGlobalSSHInstanceRequest
- type CreateGlobalSSHInstanceResponse
- type DeleteGlobalSSHInstanceRequest
- type DeleteGlobalSSHInstanceResponse
- type DescribeGlobalSSHAreaRequest
- type DescribeGlobalSSHAreaResponse
- type DescribeGlobalSSHInstanceRequest
- type DescribeGlobalSSHInstanceResponse
- type GlobalSSHArea
- type GlobalSSHInfo
- type ModifyGlobalSSHPortRequest
- type ModifyGlobalSSHPortResponse
- type ModifyGlobalSSHRemarkRequest
- type ModifyGlobalSSHRemarkResponse
- type PathXClient
- func (c *PathXClient) CreateGlobalSSHInstance(req *CreateGlobalSSHInstanceRequest) (*CreateGlobalSSHInstanceResponse, error)
- func (c *PathXClient) DeleteGlobalSSHInstance(req *DeleteGlobalSSHInstanceRequest) (*DeleteGlobalSSHInstanceResponse, error)
- func (c *PathXClient) DescribeGlobalSSHArea(req *DescribeGlobalSSHAreaRequest) (*DescribeGlobalSSHAreaResponse, error)
- func (c *PathXClient) DescribeGlobalSSHInstance(req *DescribeGlobalSSHInstanceRequest) (*DescribeGlobalSSHInstanceResponse, error)
- func (c *PathXClient) ModifyGlobalSSHPort(req *ModifyGlobalSSHPortRequest) (*ModifyGlobalSSHPortResponse, error)
- func (c *PathXClient) ModifyGlobalSSHRemark(req *ModifyGlobalSSHRemarkRequest) (*ModifyGlobalSSHRemarkResponse, error)
- func (c *PathXClient) NewCreateGlobalSSHInstanceRequest() *CreateGlobalSSHInstanceRequest
- func (c *PathXClient) NewDeleteGlobalSSHInstanceRequest() *DeleteGlobalSSHInstanceRequest
- func (c *PathXClient) NewDescribeGlobalSSHAreaRequest() *DescribeGlobalSSHAreaRequest
- func (c *PathXClient) NewDescribeGlobalSSHInstanceRequest() *DescribeGlobalSSHInstanceRequest
- func (c *PathXClient) NewModifyGlobalSSHPortRequest() *ModifyGlobalSSHPortRequest
- func (c *PathXClient) NewModifyGlobalSSHRemarkRequest() *ModifyGlobalSSHRemarkRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateGlobalSSHInstanceRequest ¶
type CreateGlobalSSHInstanceRequest struct { request.CommonBase // 填写支持SSH访问IP的地区名称,如“洛杉矶”,“新加坡”,“香港”,“东京”,“华盛顿”,“法兰克福”。Area和AreaCode两者必填一个 Area *string `required:"true"` // 被SSH访问的IP TargetIP *string `required:"true"` // SSH端口,1-65535且不能使用80,443端口 Port *int `required:"true"` // AreaCode, 区域航空港国际通用代码。Area和AreaCode两者必填一个 AreaCode *string `required:"true"` // 备注信息 Remark *string `required:"false"` // 支付方式,如按月、按年、按时 ChargeType *string `required:"false"` // 购买数量 Quantity *int `required:"false"` // 使用代金券可冲抵部分费用 CouponId *string `required:"false"` }
CreateGlobalSSHInstanceRequest is request schema for CreateGlobalSSHInstance action
type CreateGlobalSSHInstanceResponse ¶
type CreateGlobalSSHInstanceResponse struct { response.CommonBase // 实例ID,资源唯一标识 InstanceId string // 加速域名,访问该域名可就近接入 AcceleratingDomain string // 提示信息 Message string }
CreateGlobalSSHInstanceResponse is response schema for CreateGlobalSSHInstance action
type DeleteGlobalSSHInstanceRequest ¶
type DeleteGlobalSSHInstanceRequest struct { request.CommonBase // 实例Id,资源的唯一标识 InstanceId *string `required:"true"` }
DeleteGlobalSSHInstanceRequest is request schema for DeleteGlobalSSHInstance action
type DeleteGlobalSSHInstanceResponse ¶
type DeleteGlobalSSHInstanceResponse struct { response.CommonBase // 提示信息 Message string }
DeleteGlobalSSHInstanceResponse is response schema for DeleteGlobalSSHInstance action
type DescribeGlobalSSHAreaRequest ¶
type DescribeGlobalSSHAreaRequest struct {
request.CommonBase
}
DescribeGlobalSSHAreaRequest is request schema for DescribeGlobalSSHArea action
type DescribeGlobalSSHAreaResponse ¶
type DescribeGlobalSSHAreaResponse struct { response.CommonBase // 支持GlobalSSH的地区 AreaSet []GlobalSSHArea // 提示信息 Message string }
DescribeGlobalSSHAreaResponse is response schema for DescribeGlobalSSHArea action
type DescribeGlobalSSHInstanceRequest ¶
type DescribeGlobalSSHInstanceRequest struct { request.CommonBase // 实例ID,资源唯一标识 InstanceId *string `required:"false"` }
DescribeGlobalSSHInstanceRequest is request schema for DescribeGlobalSSHInstance action
type DescribeGlobalSSHInstanceResponse ¶
type DescribeGlobalSSHInstanceResponse struct { response.CommonBase // GlobalSSH实例列表,实例的属性参考GlobalSSHInfo模型 InstanceSet []GlobalSSHInfo }
DescribeGlobalSSHInstanceResponse is response schema for DescribeGlobalSSHInstance action
type GlobalSSHArea ¶
type GlobalSSHArea struct { // GlobalSSH覆盖的地区,如香港、东京、洛杉矶等 Area string // 地区代号,以地区AirPort Code AreaCode string // ucloud机房代号构成的数组,如["hk","us-ca"] RegionSet []string }
GlobalSSHArea - GlobalSSH覆盖地区,包括关联的UCloud机房信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.
type GlobalSSHInfo ¶
type GlobalSSHInfo struct { // 实例ID,资源唯一标识 InstanceId string // 加速域名 AcceleratingDomain string // 被SSH访问的IP所在地区 Area string // 被SSH访问的EIP TargetIP string // 备注信息 Remark string // SSH登陆端口 Port int // 支付周期,如Month,Year等 ChargeType string // 资源创建时间戳 CreateTime int // 资源过期时间戳 ExpireTime int }
GlobalSSHInfo - GlobalSSH实例信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.
type ModifyGlobalSSHPortRequest ¶
type ModifyGlobalSSHPortRequest struct { request.CommonBase // 实例ID,资源唯一标识 InstanceId *string `required:"true"` // 调整后的SSH登陆端口 Port *int `required:"true"` }
ModifyGlobalSSHPortRequest is request schema for ModifyGlobalSSHPort action
type ModifyGlobalSSHPortResponse ¶
type ModifyGlobalSSHPortResponse struct { response.CommonBase // 提示信息 Message string }
ModifyGlobalSSHPortResponse is response schema for ModifyGlobalSSHPort action
type ModifyGlobalSSHRemarkRequest ¶
type ModifyGlobalSSHRemarkRequest struct { request.CommonBase // 实例ID,资源唯一标识 InstanceId *string `required:"true"` // 备注信息,不填默认为空字符串 Remark *string `required:"false"` }
ModifyGlobalSSHRemarkRequest is request schema for ModifyGlobalSSHRemark action
type ModifyGlobalSSHRemarkResponse ¶
type ModifyGlobalSSHRemarkResponse struct { response.CommonBase // 接口返回消息 Message string }
ModifyGlobalSSHRemarkResponse is response schema for ModifyGlobalSSHRemark action
type PathXClient ¶
PathXClient is the client of PathX
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *PathXClient
NewClient will return a instance of PathXClient
func (*PathXClient) CreateGlobalSSHInstance ¶
func (c *PathXClient) CreateGlobalSSHInstance(req *CreateGlobalSSHInstanceRequest) (*CreateGlobalSSHInstanceResponse, error)
CreateGlobalSSHInstance - 创建GlobalSSH实例
func (*PathXClient) DeleteGlobalSSHInstance ¶
func (c *PathXClient) DeleteGlobalSSHInstance(req *DeleteGlobalSSHInstanceRequest) (*DeleteGlobalSSHInstanceResponse, error)
DeleteGlobalSSHInstance - 删除GlobalSSH实例
func (*PathXClient) DescribeGlobalSSHArea ¶
func (c *PathXClient) DescribeGlobalSSHArea(req *DescribeGlobalSSHAreaRequest) (*DescribeGlobalSSHAreaResponse, error)
DescribeGlobalSSHArea - 获取GlobalSSH覆盖的地区列表 用于控制显示哪些机房地域可以使用SSH特性
func (*PathXClient) DescribeGlobalSSHInstance ¶
func (c *PathXClient) DescribeGlobalSSHInstance(req *DescribeGlobalSSHInstanceRequest) (*DescribeGlobalSSHInstanceResponse, error)
DescribeGlobalSSHInstance - 获取GlobalSSH实例列表(传实例ID获取单个实例信息,不传获取项目下全部实例)
func (*PathXClient) ModifyGlobalSSHPort ¶
func (c *PathXClient) ModifyGlobalSSHPort(req *ModifyGlobalSSHPortRequest) (*ModifyGlobalSSHPortResponse, error)
ModifyGlobalSSHPort - 修改GlobalSSH端口
func (*PathXClient) ModifyGlobalSSHRemark ¶
func (c *PathXClient) ModifyGlobalSSHRemark(req *ModifyGlobalSSHRemarkRequest) (*ModifyGlobalSSHRemarkResponse, error)
ModifyGlobalSSHRemark - 修改GlobalSSH备注
func (*PathXClient) NewCreateGlobalSSHInstanceRequest ¶
func (c *PathXClient) NewCreateGlobalSSHInstanceRequest() *CreateGlobalSSHInstanceRequest
NewCreateGlobalSSHInstanceRequest will create request of CreateGlobalSSHInstance action.
func (*PathXClient) NewDeleteGlobalSSHInstanceRequest ¶
func (c *PathXClient) NewDeleteGlobalSSHInstanceRequest() *DeleteGlobalSSHInstanceRequest
NewDeleteGlobalSSHInstanceRequest will create request of DeleteGlobalSSHInstance action.
func (*PathXClient) NewDescribeGlobalSSHAreaRequest ¶
func (c *PathXClient) NewDescribeGlobalSSHAreaRequest() *DescribeGlobalSSHAreaRequest
NewDescribeGlobalSSHAreaRequest will create request of DescribeGlobalSSHArea action.
func (*PathXClient) NewDescribeGlobalSSHInstanceRequest ¶
func (c *PathXClient) NewDescribeGlobalSSHInstanceRequest() *DescribeGlobalSSHInstanceRequest
NewDescribeGlobalSSHInstanceRequest will create request of DescribeGlobalSSHInstance action.
func (*PathXClient) NewModifyGlobalSSHPortRequest ¶
func (c *PathXClient) NewModifyGlobalSSHPortRequest() *ModifyGlobalSSHPortRequest
NewModifyGlobalSSHPortRequest will create request of ModifyGlobalSSHPort action.
func (*PathXClient) NewModifyGlobalSSHRemarkRequest ¶
func (c *PathXClient) NewModifyGlobalSSHRemarkRequest() *ModifyGlobalSSHRemarkRequest
NewModifyGlobalSSHRemarkRequest will create request of ModifyGlobalSSHRemark action.