apis

package
v1.0.4 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2018 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BackupDownloadURLRequest 

type BackupDownloadURLRequest struct {
	core.JDCloudRequest

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

	/* backup ID  */
	BackupId string `json:"backupId"`
}

func NewBackupDownloadURLRequest 

func NewBackupDownloadURLRequest(
	regionId string,
	backupId string,
) *BackupDownloadURLRequest

* param regionId: Region ID * param backupId: backup ID

func (BackupDownloadURLRequest) GetRegionId 

func (r BackupDownloadURLRequest) GetRegionId() string

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

func (*BackupDownloadURLRequest) SetBackupId 

func (r *BackupDownloadURLRequest) SetBackupId(backupId string)

func (*BackupDownloadURLRequest) SetRegionId 

func (r *BackupDownloadURLRequest) SetRegionId(regionId string)

type BackupDownloadURLResponse 

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

type BackupDownloadURLResult 

type BackupDownloadURLResult struct {
	BackupDownloadURL mongodb.BackupDownloadURL `json:"backupDownloadURL"`
}

type CreateBackupRequest 

type CreateBackupRequest struct {
	core.JDCloudRequest

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

	/* 实例ID  */
	InstanceId string `json:""`

	/* 备份名称 (Optional) */
	BackupName *string `json:""`
}

func NewCreateBackupRequest 

func NewCreateBackupRequest(
	regionId string,
	instanceId string,
) *CreateBackupRequest

* param regionId: Region ID * param instanceId: 实例ID * param backupName: 备份名称 (Optional)

func (CreateBackupRequest) GetRegionId 

func (r CreateBackupRequest) GetRegionId() string

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

func (*CreateBackupRequest) SetBackupName 

func (r *CreateBackupRequest) SetBackupName(backupName string)

func (*CreateBackupRequest) SetInstanceId 

func (r *CreateBackupRequest) SetInstanceId(instanceId string)

func (*CreateBackupRequest) SetRegionId 

func (r *CreateBackupRequest) SetRegionId(regionId string)

type CreateBackupResponse 

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

type CreateBackupResult 

type CreateBackupResult struct {
	BackupId string `json:"backupId"`
}

type CreateInstanceRequest 

type CreateInstanceRequest struct {
	core.JDCloudRequest

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

	/* 实例规格  */
	InstanceSpec *mongodb.DBInstanceSpec `json:"instanceSpec"`

	/* 付费方式 (Optional) */
	ChargeSpec *charge.ChargeSpec `json:"chargeSpec"`
}

func NewCreateInstanceRequest 

func NewCreateInstanceRequest(
	regionId string,
	instanceSpec *mongodb.DBInstanceSpec,
) *CreateInstanceRequest

* param regionId: Region ID * param instanceSpec: 实例规格 * param chargeSpec: 付费方式 (Optional)

func (CreateInstanceRequest) GetRegionId 

func (r CreateInstanceRequest) GetRegionId() string

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

func (*CreateInstanceRequest) SetChargeSpec 

func (r *CreateInstanceRequest) SetChargeSpec(chargeSpec *charge.ChargeSpec)

func (*CreateInstanceRequest) SetInstanceSpec 

func (r *CreateInstanceRequest) SetInstanceSpec(instanceSpec *mongodb.DBInstanceSpec)

func (*CreateInstanceRequest) SetRegionId 

func (r *CreateInstanceRequest) SetRegionId(regionId string)

type CreateInstanceResponse 

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

type CreateInstanceResult 

type CreateInstanceResult struct {
	InstanceId string `json:"instanceId"`
	OrderId    string `json:"orderId"`
}

type DeleteBackupRequest 

type DeleteBackupRequest struct {
	core.JDCloudRequest

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

	/* backup ID  */
	BackupId string `json:"backupId"`
}

func NewDeleteBackupRequest 

func NewDeleteBackupRequest(
	regionId string,
	backupId string,
) *DeleteBackupRequest

* param regionId: Region ID * param backupId: backup ID

func (DeleteBackupRequest) GetRegionId 

func (r DeleteBackupRequest) GetRegionId() string

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

func (*DeleteBackupRequest) SetBackupId 

func (r *DeleteBackupRequest) SetBackupId(backupId string)

func (*DeleteBackupRequest) SetRegionId 

func (r *DeleteBackupRequest) SetRegionId(regionId string)

type DeleteBackupResponse 

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

type DeleteBackupResult 

type DeleteBackupResult struct {
}

type DeleteInstanceRequest 

type DeleteInstanceRequest struct {
	core.JDCloudRequest

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

	/* Instance ID  */
	InstanceId string `json:"instanceId"`
}

func NewDeleteInstanceRequest 

func NewDeleteInstanceRequest(
	regionId string,
	instanceId string,
) *DeleteInstanceRequest

* param regionId: Region ID * param instanceId: Instance ID

func (DeleteInstanceRequest) GetRegionId 

func (r DeleteInstanceRequest) GetRegionId() string

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

func (*DeleteInstanceRequest) SetInstanceId 

func (r *DeleteInstanceRequest) SetInstanceId(instanceId string)

func (*DeleteInstanceRequest) SetRegionId 

func (r *DeleteInstanceRequest) SetRegionId(regionId string)

type DeleteInstanceResponse 

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

type DeleteInstanceResult 

type DeleteInstanceResult struct {
}

type DescribeBackupPolicyRequest 

type DescribeBackupPolicyRequest struct {
	core.JDCloudRequest

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

	/* Instance ID  */
	InstanceId string `json:"instanceId"`
}

func NewDescribeBackupPolicyRequest 

func NewDescribeBackupPolicyRequest(
	regionId string,
	instanceId string,
) *DescribeBackupPolicyRequest

* param regionId: Region ID * param instanceId: Instance ID

func (DescribeBackupPolicyRequest) GetRegionId 

func (r DescribeBackupPolicyRequest) GetRegionId() string

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

func (*DescribeBackupPolicyRequest) SetInstanceId 

func (r *DescribeBackupPolicyRequest) SetInstanceId(instanceId string)

func (*DescribeBackupPolicyRequest) SetRegionId 

func (r *DescribeBackupPolicyRequest) SetRegionId(regionId string)

type DescribeBackupPolicyResponse 

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

type DescribeBackupPolicyResult 

type DescribeBackupPolicyResult struct {
	PreferredBackupPeriod string `json:"preferredBackupPeriod"`
	PreferredBackupWindow string `json:"preferredBackupWindow"`
	BackupRetentionPeriod string `json:"backupRetentionPeriod"`
}

type DescribeBackupsRequest 

type DescribeBackupsRequest struct {
	core.JDCloudRequest

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

	/* 页码；默认为1，取值范围：[1,∞) (Optional) */
	PageNumber *int `json:"pageNumber"`

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

	/* instanceId - 实例ID, 精确匹配
	backupId - 备份ID, 精确匹配
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeBackupsRequest 

func NewDescribeBackupsRequest(
	regionId string,
) *DescribeBackupsRequest
  • param regionId: Region ID
  • param pageNumber: 页码；默认为1，取值范围：[1,∞) (Optional)
  • param pageSize: 分页大小；默认为10；取值范围[1, 100] (Optional)
  • param filters: instanceId - 实例ID, 精确匹配

backupId - 备份ID, 精确匹配 

(Optional)

func (DescribeBackupsRequest) GetRegionId 

func (r DescribeBackupsRequest) GetRegionId() string

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

func (*DescribeBackupsRequest) SetFilters 

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

func (*DescribeBackupsRequest) SetPageNumber 

func (r *DescribeBackupsRequest) SetPageNumber(pageNumber int)

func (*DescribeBackupsRequest) SetPageSize 

func (r *DescribeBackupsRequest) SetPageSize(pageSize int)

func (*DescribeBackupsRequest) SetRegionId 

func (r *DescribeBackupsRequest) SetRegionId(regionId string)

type DescribeBackupsResponse 

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

type DescribeBackupsResult 

type DescribeBackupsResult struct {
	Backups    []mongodb.Backup `json:"backups"`
	TotalCount int              `json:"totalCount"`
	PageNumber int              `json:"pageNumber"`
}

type DescribeInstancesRequest 

type DescribeInstancesRequest struct {
	core.JDCloudRequest

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

	/* 页码；默认为1，取值范围：[1,∞) (Optional) */
	PageNumber *int `json:"pageNumber"`

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

	/* instanceId - 实例ID, 精确匹配
	instanceName - 实例名称, 模糊匹配
	instanceStatus - mongodb状态，精确匹配，支持多个.RUNNING：运行, ERROR：错误 ,BUILDING：创建中, DELETING：删除中, RESTORING：恢复中, RESIZING：变配中
	 (Optional) */
	Filters []common.Filter `json:"filters"`

	/* createTime - 创建时间,asc（正序），desc（倒序）
	(Optional) */
	Sorts []common.Sort `json:"sorts"`
}

func NewDescribeInstancesRequest 

func NewDescribeInstancesRequest(
	regionId string,
) *DescribeInstancesRequest
  • param regionId: Region ID
  • param pageNumber: 页码；默认为1，取值范围：[1,∞) (Optional)
  • param pageSize: 分页大小；默认为10；取值范围[1, 100] (Optional)
  • param filters: instanceId - 实例ID, 精确匹配

instanceName - 实例名称, 模糊匹配 instanceStatus - mongodb状态，精确匹配，支持多个.RUNNING：运行, ERROR：错误 ,BUILDING：创建中, DELETING：删除中, RESTORING：恢复中, RESIZING：变配中 

(Optional)
* param sorts: createTime - 创建时间,asc（正序），desc（倒序）
(Optional)

func (DescribeInstancesRequest) GetRegionId 

func (r DescribeInstancesRequest) GetRegionId() string

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

func (*DescribeInstancesRequest) SetFilters 

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

func (*DescribeInstancesRequest) SetPageNumber 

func (r *DescribeInstancesRequest) SetPageNumber(pageNumber int)

func (*DescribeInstancesRequest) SetPageSize 

func (r *DescribeInstancesRequest) SetPageSize(pageSize int)

func (*DescribeInstancesRequest) SetRegionId 

func (r *DescribeInstancesRequest) SetRegionId(regionId string)

func (*DescribeInstancesRequest) SetSorts 

func (r *DescribeInstancesRequest) SetSorts(sorts []common.Sort)

type DescribeInstancesResponse 

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

type DescribeInstancesResult 

type DescribeInstancesResult struct {
	DbInstances []mongodb.DBInstance `json:"dbInstances"`
	TotalCount  int                  `json:"totalCount"`
	PageNumber  int                  `json:"pageNumber"`
}

type ModifyBackupPolicyRequest 

type ModifyBackupPolicyRequest struct {
	core.JDCloudRequest

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

	/* Instance ID  */
	InstanceId string `json:"instanceId"`

	/* 备份时间，格式：HH:mmZ- HH:mmZ，只允许间隔时间为1小时的整点.  */
	PreferredBackupTime string `json:""`
}

func NewModifyBackupPolicyRequest 

func NewModifyBackupPolicyRequest(
	regionId string,
	instanceId string,
	preferredBackupTime string,
) *ModifyBackupPolicyRequest

* param regionId: Region ID * param instanceId: Instance ID * param preferredBackupTime: 备份时间，格式：HH:mmZ- HH:mmZ，只允许间隔时间为1小时的整点.

func (ModifyBackupPolicyRequest) GetRegionId 

func (r ModifyBackupPolicyRequest) GetRegionId() string

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

func (*ModifyBackupPolicyRequest) SetInstanceId 

func (r *ModifyBackupPolicyRequest) SetInstanceId(instanceId string)

func (*ModifyBackupPolicyRequest) SetPreferredBackupTime 

func (r *ModifyBackupPolicyRequest) SetPreferredBackupTime(preferredBackupTime string)

func (*ModifyBackupPolicyRequest) SetRegionId 

func (r *ModifyBackupPolicyRequest) SetRegionId(regionId string)

type ModifyBackupPolicyResponse 

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

type ModifyBackupPolicyResult 

type ModifyBackupPolicyResult struct {
	PreferredBackupPeriod string `json:"preferredBackupPeriod"`
	PreferredBackupWindow string `json:"preferredBackupWindow"`
	BackupRetentionPeriod string `json:"backupRetentionPeriod"`
}

type ModifyInstanceNameRequest 

type ModifyInstanceNameRequest struct {
	core.JDCloudRequest

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

	/* Instance ID  */
	InstanceId string `json:"instanceId"`

	/* 新的实例名称，只支持数字、字母、英文下划线、中文，且不少于2字符不超过32字符。  */
	InstanceName string `json:""`
}

func NewModifyInstanceNameRequest 

func NewModifyInstanceNameRequest(
	regionId string,
	instanceId string,
	instanceName string,
) *ModifyInstanceNameRequest

* param regionId: Region ID * param instanceId: Instance ID * param instanceName: 新的实例名称，只支持数字、字母、英文下划线、中文，且不少于2字符不超过32字符。

func (ModifyInstanceNameRequest) GetRegionId 

func (r ModifyInstanceNameRequest) GetRegionId() string

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

func (*ModifyInstanceNameRequest) SetInstanceId 

func (r *ModifyInstanceNameRequest) SetInstanceId(instanceId string)

func (*ModifyInstanceNameRequest) SetInstanceName 

func (r *ModifyInstanceNameRequest) SetInstanceName(instanceName string)

func (*ModifyInstanceNameRequest) SetRegionId 

func (r *ModifyInstanceNameRequest) SetRegionId(regionId string)

type ModifyInstanceNameResponse 

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

type ModifyInstanceNameResult 

type ModifyInstanceNameResult struct {
}

type ModifyInstanceSpecRequest 

type ModifyInstanceSpecRequest struct {
	core.JDCloudRequest

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

	/* Instance ID  */
	InstanceId string `json:"instanceId"`

	/* 实例规格，包年包月不允许小于当前规格。  */
	InstanceClass string `json:""`

	/* 存储空间，包年包月不允许小于当前规格。  */
	InstanceStorageGB int `json:""`
}

func NewModifyInstanceSpecRequest 

func NewModifyInstanceSpecRequest(
	regionId string,
	instanceId string,
	instanceClass string,
	instanceStorageGB int,
) *ModifyInstanceSpecRequest

* param regionId: Region ID * param instanceId: Instance ID * param instanceClass: 实例规格，包年包月不允许小于当前规格。 * param instanceStorageGB: 存储空间，包年包月不允许小于当前规格。

func (ModifyInstanceSpecRequest) GetRegionId 

func (r ModifyInstanceSpecRequest) GetRegionId() string

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

func (*ModifyInstanceSpecRequest) SetInstanceClass 

func (r *ModifyInstanceSpecRequest) SetInstanceClass(instanceClass string)

func (*ModifyInstanceSpecRequest) SetInstanceId 

func (r *ModifyInstanceSpecRequest) SetInstanceId(instanceId string)

func (*ModifyInstanceSpecRequest) SetInstanceStorageGB 

func (r *ModifyInstanceSpecRequest) SetInstanceStorageGB(instanceStorageGB int)

func (*ModifyInstanceSpecRequest) SetRegionId 

func (r *ModifyInstanceSpecRequest) SetRegionId(regionId string)

type ModifyInstanceSpecResponse 

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

type ModifyInstanceSpecResult 

type ModifyInstanceSpecResult struct {
	InstanceId string `json:"instanceId"`
	OrderId    string `json:"orderId"`
}

type ResetPasswordRequest 

type ResetPasswordRequest struct {
	core.JDCloudRequest

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

	/* Instance ID  */
	InstanceId string `json:"instanceId"`

	/* 新密码，必须包含且只支持字母及数字，不少于8字符不超过16字符。  */
	AccountPassword string `json:""`
}

func NewResetPasswordRequest 

func NewResetPasswordRequest(
	regionId string,
	instanceId string,
	accountPassword string,
) *ResetPasswordRequest

* param regionId: Region ID * param instanceId: Instance ID * param accountPassword: 新密码，必须包含且只支持字母及数字，不少于8字符不超过16字符。

func (ResetPasswordRequest) GetRegionId 

func (r ResetPasswordRequest) GetRegionId() string

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

func (*ResetPasswordRequest) SetAccountPassword 

func (r *ResetPasswordRequest) SetAccountPassword(accountPassword string)

func (*ResetPasswordRequest) SetInstanceId 

func (r *ResetPasswordRequest) SetInstanceId(instanceId string)

func (*ResetPasswordRequest) SetRegionId 

func (r *ResetPasswordRequest) SetRegionId(regionId string)

type ResetPasswordResponse 

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

type ResetPasswordResult 

type ResetPasswordResult struct {
}

type RestoreInstanceRequest 

type RestoreInstanceRequest struct {
	core.JDCloudRequest

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

	/* Instance ID  */
	InstanceId string `json:"instanceId"`

	/* 备份ID  */
	BackupId string `json:""`
}

func NewRestoreInstanceRequest 

func NewRestoreInstanceRequest(
	regionId string,
	instanceId string,
	backupId string,
) *RestoreInstanceRequest

* param regionId: Region ID * param instanceId: Instance ID * param backupId: 备份ID

func (RestoreInstanceRequest) GetRegionId 

func (r RestoreInstanceRequest) GetRegionId() string

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

func (*RestoreInstanceRequest) SetBackupId 

func (r *RestoreInstanceRequest) SetBackupId(backupId string)

func (*RestoreInstanceRequest) SetInstanceId 

func (r *RestoreInstanceRequest) SetInstanceId(instanceId string)

func (*RestoreInstanceRequest) SetRegionId 

func (r *RestoreInstanceRequest) SetRegionId(regionId string)

type RestoreInstanceResponse 

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

type RestoreInstanceResult 

type RestoreInstanceResult struct {
}

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.