apis

package
v1.35.0 Latest Latest
Warning

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

 Go to latest Published: Jul 13, 2020 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 CreateInstanceRequest 

type CreateInstanceRequest struct {
	core.JDCloudRequest

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

	/* kafka实例的相关配置  */
	Instance *kafka.InstanceSpec `json:"instance"`

	/* 计费信息的相关配置，只有prepaid_by_duration和postpaid_by_duration 2种计费模式 (Optional) */
	Charge *charge.ChargeSpec `json:"charge"`
}

func NewCreateInstanceRequest 

func NewCreateInstanceRequest(
	regionId string,
	instance *kafka.InstanceSpec,
) *CreateInstanceRequest

* param regionId: regionId (Required) * param instance: kafka实例的相关配置 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCreateInstanceRequestWithAllParams 

func NewCreateInstanceRequestWithAllParams(
	regionId string,
	instance *kafka.InstanceSpec,
	charge *charge.ChargeSpec,
) *CreateInstanceRequest

* param regionId: regionId (Required) * param instance: kafka实例的相关配置 (Required) * param charge: 计费信息的相关配置，只有prepaid_by_duration和postpaid_by_duration 2种计费模式 (Optional)

func NewCreateInstanceRequestWithoutParam 

func NewCreateInstanceRequestWithoutParam() *CreateInstanceRequest

This constructor has better compatible ability when API parameters changed

func (CreateInstanceRequest) GetRegionId 

func (r CreateInstanceRequest) GetRegionId() string

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

func (*CreateInstanceRequest) SetCharge 

func (r *CreateInstanceRequest) SetCharge(charge *charge.ChargeSpec)

param charge: 计费信息的相关配置，只有prepaid_by_duration和postpaid_by_duration 2种计费模式(Optional)

func (*CreateInstanceRequest) SetInstance 

func (r *CreateInstanceRequest) SetInstance(instance *kafka.InstanceSpec)

param instance: kafka实例的相关配置(Required)

func (*CreateInstanceRequest) SetRegionId 

func (r *CreateInstanceRequest) SetRegionId(regionId string)

param regionId: regionId(Required)

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"`
	BuyId      string `json:"buyId"`
}

type DeleteInstanceRequest 

type DeleteInstanceRequest struct {
	core.JDCloudRequest

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

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

func NewDeleteInstanceRequest 

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

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

func NewDeleteInstanceRequestWithAllParams 

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

* param regionId: regionId (Required) * param instanceId: 实例ID (Required)

func NewDeleteInstanceRequestWithoutParam 

func NewDeleteInstanceRequestWithoutParam() *DeleteInstanceRequest

This constructor has better compatible ability when API parameters changed

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)

param instanceId: 实例ID(Required)

func (*DeleteInstanceRequest) SetRegionId 

func (r *DeleteInstanceRequest) SetRegionId(regionId string)

param regionId: regionId(Required)

type DeleteInstanceResponse 

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

type DeleteInstanceResult 

type DeleteInstanceResult struct {
}

type DescribeInstanceRequest 

type DescribeInstanceRequest struct {
	core.JDCloudRequest

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

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

func NewDescribeInstanceRequest 

func NewDescribeInstanceRequest(
	regionId string,
	instanceId string,
) *DescribeInstanceRequest

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

func NewDescribeInstanceRequestWithAllParams 

func NewDescribeInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
) *DescribeInstanceRequest

* param regionId: regionId (Required) * param instanceId: 实例ID (Required)

func NewDescribeInstanceRequestWithoutParam 

func NewDescribeInstanceRequestWithoutParam() *DescribeInstanceRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstanceRequest) GetRegionId 

func (r DescribeInstanceRequest) GetRegionId() string

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

func (*DescribeInstanceRequest) SetInstanceId 

func (r *DescribeInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 实例ID(Required)

func (*DescribeInstanceRequest) SetRegionId 

func (r *DescribeInstanceRequest) SetRegionId(regionId string)

param regionId: regionId(Required)

type DescribeInstanceResponse 

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

type DescribeInstanceResult 

type DescribeInstanceResult struct {
	Instance kafka.Instance `json:"instance"`
}

type DescribeInstancesRequest 

type DescribeInstancesRequest struct {
	core.JDCloudRequest

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

	/* 页码，默认1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小，默认10 (Optional) */
	PageSize *int `json:"pageSize"`

	/* 过滤条件：
	instanceId -实例Id，精确匹配，支持多个
	instanceVersion -实例版本，精确匹配，支持单个
	instanceName - 实例名称，模糊匹配，支持单个
	instanceStatus - 实例状态，精确匹配，支持多个(running：运行，error：错误，creating：创建中，changing：变配中，stop：已停止，processing：处理中)
	chargeMode - 计费类型，按配置postpaid_by_duration或者包年包月prepaid_by_duration
	 (Optional) */
	Filters []common.Filter `json:"filters"`

	/* 标签过滤条件 (Optional) */
	TagFilters []common.TagFilter `json:"tagFilters"`
}

func NewDescribeInstancesRequest 

func NewDescribeInstancesRequest(
	regionId string,
) *DescribeInstancesRequest

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

func NewDescribeInstancesRequestWithAllParams 

func NewDescribeInstancesRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
	tagFilters []common.TagFilter,
) *DescribeInstancesRequest
  • param regionId: regionId (Required)
  • param pageNumber: 页码，默认1 (Optional)
  • param pageSize: 分页大小，默认10 (Optional)
  • param filters: 过滤条件：

instanceId -实例Id，精确匹配，支持多个 instanceVersion -实例版本，精确匹配，支持单个 instanceName - 实例名称，模糊匹配，支持单个 instanceStatus - 实例状态，精确匹配，支持多个(running：运行，error：错误，creating：创建中，changing：变配中，stop：已停止，processing：处理中) chargeMode - 计费类型，按配置postpaid_by_duration或者包年包月prepaid_by_duration 

(Optional)
* param tagFilters: 标签过滤条件 (Optional)

func NewDescribeInstancesRequestWithoutParam 

func NewDescribeInstancesRequestWithoutParam() *DescribeInstancesRequest

This constructor has better compatible ability when API parameters changed

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)
param filters: 过滤条件：

instanceId -实例Id，精确匹配，支持多个 instanceVersion -实例版本，精确匹配，支持单个 instanceName - 实例名称，模糊匹配，支持单个 instanceStatus - 实例状态，精确匹配，支持多个(running：运行，error：错误，creating：创建中，changing：变配中，stop：已停止，processing：处理中) chargeMode - 计费类型，按配置postpaid_by_duration或者包年包月prepaid_by_duration (Optional)

func (*DescribeInstancesRequest) SetPageNumber 

func (r *DescribeInstancesRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码，默认1(Optional)

func (*DescribeInstancesRequest) SetPageSize 

func (r *DescribeInstancesRequest) SetPageSize(pageSize int)

param pageSize: 分页大小，默认10(Optional)

func (*DescribeInstancesRequest) SetRegionId 

func (r *DescribeInstancesRequest) SetRegionId(regionId string)

param regionId: regionId(Required)

func (*DescribeInstancesRequest) SetTagFilters 

func (r *DescribeInstancesRequest) SetTagFilters(tagFilters []common.TagFilter)

param tagFilters: 标签过滤条件(Optional)

type DescribeInstancesResponse 

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

type DescribeInstancesResult 

type DescribeInstancesResult struct {
	Instances  []kafka.Instance `json:"instances"`
	TotalCount int              `json:"totalCount"`
}

type ModifyInstanceSpecRequest 

type ModifyInstanceSpecRequest struct {
	core.JDCloudRequest

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

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

	/* 变更的规格  */
	InstanceClassSpec []kafka.InstanceClassSpec `json:"instanceClassSpec"`
}

func NewModifyInstanceSpecRequest 

func NewModifyInstanceSpecRequest(
	regionId string,
	instanceId string,
	instanceClassSpec []kafka.InstanceClassSpec,
) *ModifyInstanceSpecRequest

* param regionId: regionId (Required) * param instanceId: 实例ID (Required) * param instanceClassSpec: 变更的规格 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModifyInstanceSpecRequestWithAllParams 

func NewModifyInstanceSpecRequestWithAllParams(
	regionId string,
	instanceId string,
	instanceClassSpec []kafka.InstanceClassSpec,
) *ModifyInstanceSpecRequest

* param regionId: regionId (Required) * param instanceId: 实例ID (Required) * param instanceClassSpec: 变更的规格 (Required)

func NewModifyInstanceSpecRequestWithoutParam 

func NewModifyInstanceSpecRequestWithoutParam() *ModifyInstanceSpecRequest

This constructor has better compatible ability when API parameters changed

func (ModifyInstanceSpecRequest) GetRegionId 

func (r ModifyInstanceSpecRequest) GetRegionId() string

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

func (*ModifyInstanceSpecRequest) SetInstanceClassSpec 

func (r *ModifyInstanceSpecRequest) SetInstanceClassSpec(instanceClassSpec []kafka.InstanceClassSpec)

param instanceClassSpec: 变更的规格(Required)

func (*ModifyInstanceSpecRequest) SetInstanceId 

func (r *ModifyInstanceSpecRequest) SetInstanceId(instanceId string)

param instanceId: 实例ID(Required)

func (*ModifyInstanceSpecRequest) SetRegionId 

func (r *ModifyInstanceSpecRequest) SetRegionId(regionId string)

param regionId: regionId(Required)

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"`
	BuyId      string `json:"buyId"`
}

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.