apis

Documentation

Index

• type DescribeConnectionsRequest
  • func NewDescribeConnectionsRequest(regionId string) *DescribeConnectionsRequest
  • func NewDescribeConnectionsRequestWithAllParams(regionId string, pageNumber *int, pageSize *int, filters []common.Filter) *DescribeConnectionsRequest
  • func NewDescribeConnectionsRequestWithoutParam() *DescribeConnectionsRequest
  • func (r DescribeConnectionsRequest) GetRegionId() string
  • func (r *DescribeConnectionsRequest) SetFilters(filters []common.Filter)
  • func (r *DescribeConnectionsRequest) SetPageNumber(pageNumber int)
  • func (r *DescribeConnectionsRequest) SetPageSize(pageSize int)
  • func (r *DescribeConnectionsRequest) SetRegionId(regionId string)
• type DescribeConnectionsResponse
• type DescribeConnectionsResult
• type ModifyAdminStatusRequest
  • func NewModifyAdminStatusRequest(regionId string, vpnTunnelId string, adminStatus string) *ModifyAdminStatusRequest
  • func NewModifyAdminStatusRequestWithAllParams(regionId string, vpnTunnelId string, adminStatus string) *ModifyAdminStatusRequest
  • func NewModifyAdminStatusRequestWithoutParam() *ModifyAdminStatusRequest
  • func (r ModifyAdminStatusRequest) GetRegionId() string
  • func (r *ModifyAdminStatusRequest) SetAdminStatus(adminStatus string)
  • func (r *ModifyAdminStatusRequest) SetRegionId(regionId string)
  • func (r *ModifyAdminStatusRequest) SetVpnTunnelId(vpnTunnelId string)
• type ModifyAdminStatusResponse
• type ModifyAdminStatusResult

Types

type DescribeConnectionsRequest

type DescribeConnectionsRequest struct {
	core.JDCloudRequest

	/* Region ID  */
	RegionId string `json:"regionId"`

	/* 页码, 默认为1, 取值范围：[1,∞), 页码超过总页数时, 显示最后一页 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小，默认为20，取值范围：[10,100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* connectionIds - 连接ID列表，支持多个
	connectionNames - 连接名称列表,支持多个
	types - 类型，取值：jcloud_hosted:托管连接、jcloud_partner:合作伙伴连接、jcloud:自助连接, 支持多个
	status - Connection状态,支持单个。取值为：待审核(Ordering)、待支付(Installation_Paying)、施工中(Pending)、等待确认(Confirming)、可用(Active)、不可用(InActive)、删除中(Deleting)、已删除(Deleted)、审核未通过(Rejected)
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeConnectionsRequest

func NewDescribeConnectionsRequest(
	regionId string,
) *DescribeConnectionsRequest

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

func NewDescribeConnectionsRequestWithAllParams

func NewDescribeConnectionsRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
) *DescribeConnectionsRequest

• param regionId: Region ID (Required)
• param pageNumber: 页码, 默认为1, 取值范围：[1,∞), 页码超过总页数时, 显示最后一页 (Optional)
• param pageSize: 分页大小，默认为20，取值范围：[10,100] (Optional)
• param filters: connectionIds - 连接ID列表，支持多个

connectionNames - 连接名称列表,支持多个 types - 类型，取值：jcloud_hosted:托管连接、jcloud_partner:合作伙伴连接、jcloud:自助连接, 支持多个 status - Connection状态,支持单个。取值为：待审核(Ordering)、待支付(Installation_Paying)、施工中(Pending)、等待确认(Confirming)、可用(Active)、不可用(InActive)、删除中(Deleting)、已删除(Deleted)、审核未通过(Rejected)

(Optional)

func NewDescribeConnectionsRequestWithoutParam

func NewDescribeConnectionsRequestWithoutParam() *DescribeConnectionsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeConnectionsRequest) GetRegionId

func (r DescribeConnectionsRequest) GetRegionId() string

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

func (*DescribeConnectionsRequest) SetFilters

func (r *DescribeConnectionsRequest) SetFilters(filters []common.Filter)

param filters: connectionIds - 连接ID列表，支持多个

connectionNames - 连接名称列表,支持多个 types - 类型，取值：jcloud_hosted:托管连接、jcloud_partner:合作伙伴连接、jcloud:自助连接, 支持多个 status - Connection状态,支持单个。取值为：待审核(Ordering)、待支付(Installation_Paying)、施工中(Pending)、等待确认(Confirming)、可用(Active)、不可用(InActive)、删除中(Deleting)、已删除(Deleted)、审核未通过(Rejected) (Optional)

func (*DescribeConnectionsRequest) SetPageNumber

func (r *DescribeConnectionsRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码, 默认为1, 取值范围：[1,∞), 页码超过总页数时, 显示最后一页(Optional)

func (*DescribeConnectionsRequest) SetPageSize

func (r *DescribeConnectionsRequest) SetPageSize(pageSize int)

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

func (*DescribeConnectionsRequest) SetRegionId

func (r *DescribeConnectionsRequest) SetRegionId(regionId string)

param regionId: Region ID(Required)

type DescribeConnectionsResponse

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

type DescribeConnectionsResult

type DescribeConnectionsResult struct {
	Connections []bgw.Connection `json:"connections"`
	TotalCount  int              `json:"totalCount"`
}

type ModifyAdminStatusRequest

type ModifyAdminStatusRequest struct {
	core.JDCloudRequest

	/* Region ID  */
	RegionId string `json:"regionId"`

	/* VPN Tunnel ID  */
	VpnTunnelId string `json:"vpnTunnelId"`

	/* 隧道管理状态, UP, DOWN  */
	AdminStatus string `json:"adminStatus"`
}

func NewModifyAdminStatusRequest

func NewModifyAdminStatusRequest(
	regionId string,
	vpnTunnelId string,
	adminStatus string,
) *ModifyAdminStatusRequest

* param regionId: Region ID (Required) * param vpnTunnelId: VPN Tunnel ID (Required) * param adminStatus: 隧道管理状态, UP, DOWN (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModifyAdminStatusRequestWithAllParams

func NewModifyAdminStatusRequestWithAllParams(
	regionId string,
	vpnTunnelId string,
	adminStatus string,
) *ModifyAdminStatusRequest

* param regionId: Region ID (Required) * param vpnTunnelId: VPN Tunnel ID (Required) * param adminStatus: 隧道管理状态, UP, DOWN (Required)

func NewModifyAdminStatusRequestWithoutParam

func NewModifyAdminStatusRequestWithoutParam() *ModifyAdminStatusRequest

This constructor has better compatible ability when API parameters changed

func (ModifyAdminStatusRequest) GetRegionId

func (r ModifyAdminStatusRequest) GetRegionId() string

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

func (*ModifyAdminStatusRequest) SetAdminStatus

func (r *ModifyAdminStatusRequest) SetAdminStatus(adminStatus string)

param adminStatus: 隧道管理状态, UP, DOWN(Required)

func (*ModifyAdminStatusRequest) SetRegionId

func (r *ModifyAdminStatusRequest) SetRegionId(regionId string)

param regionId: Region ID(Required)

func (*ModifyAdminStatusRequest) SetVpnTunnelId

func (r *ModifyAdminStatusRequest) SetVpnTunnelId(vpnTunnelId string)

param vpnTunnelId: VPN Tunnel ID(Required)

type ModifyAdminStatusResponse

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

type ModifyAdminStatusResult

type ModifyAdminStatusResult struct {
}