v20201230

package
v3.0.1182+incompatible Latest Latest
Warning

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

Go to latest
Published: Apr 21, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// Internal error.
	INTERNALERROR = "InternalError"

	// InternalError.SystemError
	INTERNALERROR_SYSTEMERROR = "InternalError.SystemError"
)
View Source
const APIVersion = "2020-12-30"

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessInfo

type AccessInfo struct {
	// Address.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// Protocol.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`
}

type CBSSpec

type CBSSpec struct {
	// Disk type.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Size.
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// Number.
	DiskCount *int64 `json:"DiskCount,omitnil,omitempty" name:"DiskCount"`
}

type CBSSpecInfo

type CBSSpecInfo struct {
	// Disk type.Note: This field may return null, indicating that no valid values can be obtained.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Size.
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// Number.Note: This field may return null, indicating that no valid values can be obtained.
	DiskCount *int64 `json:"DiskCount,omitnil,omitempty" name:"DiskCount"`
}

type ChargeProperties

type ChargeProperties struct {
	// 1: requires auto-renewal.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RenewFlag *int64 `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`

	// Order time range.
	// Note: This field may return null, indicating that no valid values can be obtained.
	TimeSpan *int64 `json:"TimeSpan,omitnil,omitempty" name:"TimeSpan"`

	// Time unit. Valid values: h and m.
	// Note: This field may return null, indicating that no valid values can be obtained.
	TimeUnit *string `json:"TimeUnit,omitnil,omitempty" name:"TimeUnit"`

	// Billing type: 0 indicates pay-as-you-go and 1 indicates monthly subscription.
	// Note: This field may return null, indicating that no valid values can be obtained.
	PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// PREPAID and POSTPAID_BY_HOUR
	// Note: This field may return null, indicating that no valid values can be obtained.
	ChargeType *string `json:"ChargeType,omitnil,omitempty" name:"ChargeType"`
}

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateInstanceByApi

func (c *Client) CreateInstanceByApi(request *CreateInstanceByApiRequest) (response *CreateInstanceByApiResponse, err error)

CreateInstanceByApi This API is used to create instance

func (*Client) CreateInstanceByApiWithContext

func (c *Client) CreateInstanceByApiWithContext(ctx context.Context, request *CreateInstanceByApiRequest) (response *CreateInstanceByApiResponse, err error)

CreateInstanceByApi This API is used to create instance

func (*Client) DescribeInstance

func (c *Client) DescribeInstance(request *DescribeInstanceRequest) (response *DescribeInstanceResponse, err error)

DescribeInstance This API is used to query the instance information by an instance ID.

func (*Client) DescribeInstanceInfo

func (c *Client) DescribeInstanceInfo(request *DescribeInstanceInfoRequest) (response *DescribeInstanceInfoResponse, err error)

DescribeInstanceInfo This API is used to get instance information.

func (*Client) DescribeInstanceInfoWithContext

func (c *Client) DescribeInstanceInfoWithContext(ctx context.Context, request *DescribeInstanceInfoRequest) (response *DescribeInstanceInfoResponse, err error)

DescribeInstanceInfo This API is used to get instance information.

func (*Client) DescribeInstanceState

func (c *Client) DescribeInstanceState(request *DescribeInstanceStateRequest) (response *DescribeInstanceStateResponse, err error)

DescribeInstanceState This API is used to display instance status, process progress, etc., in the instance details page.

func (*Client) DescribeInstanceStateWithContext

func (c *Client) DescribeInstanceStateWithContext(ctx context.Context, request *DescribeInstanceStateRequest) (response *DescribeInstanceStateResponse, err error)

DescribeInstanceState This API is used to display instance status, process progress, etc., in the instance details page.

func (*Client) DescribeInstanceWithContext

func (c *Client) DescribeInstanceWithContext(ctx context.Context, request *DescribeInstanceRequest) (response *DescribeInstanceResponse, err error)

DescribeInstance This API is used to query the instance information by an instance ID.

func (*Client) DescribeInstances

func (c *Client) DescribeInstances(request *DescribeInstancesRequest) (response *DescribeInstancesResponse, err error)

DescribeInstances This API is used to get a list of instances.

error code that may be returned:

INTERNALERROR = "InternalError"

func (*Client) DescribeInstancesWithContext

func (c *Client) DescribeInstancesWithContext(ctx context.Context, request *DescribeInstancesRequest) (response *DescribeInstancesResponse, err error)

DescribeInstances This API is used to get a list of instances.

error code that may be returned:

INTERNALERROR = "InternalError"

func (*Client) DescribeSimpleInstances

func (c *Client) DescribeSimpleInstances(request *DescribeSimpleInstancesRequest) (response *DescribeSimpleInstancesResponse, err error)

DescribeSimpleInstances This API is used to get a list of instance

error code that may be returned:

INTERNALERROR_SYSTEMERROR = "InternalError.SystemError"

func (*Client) DescribeSimpleInstancesWithContext

func (c *Client) DescribeSimpleInstancesWithContext(ctx context.Context, request *DescribeSimpleInstancesRequest) (response *DescribeSimpleInstancesResponse, err error)

DescribeSimpleInstances This API is used to get a list of instance

error code that may be returned:

INTERNALERROR_SYSTEMERROR = "InternalError.SystemError"

func (*Client) DestroyInstanceByApi

func (c *Client) DestroyInstanceByApi(request *DestroyInstanceByApiRequest) (response *DestroyInstanceByApiResponse, err error)

DestroyInstanceByApi This API is used to destroy instance.

error code that may be returned:

INTERNALERROR_SYSTEMERROR = "InternalError.SystemError"

func (*Client) DestroyInstanceByApiWithContext

func (c *Client) DestroyInstanceByApiWithContext(ctx context.Context, request *DestroyInstanceByApiRequest) (response *DestroyInstanceByApiResponse, err error)

DestroyInstanceByApi This API is used to destroy instance.

error code that may be returned:

INTERNALERROR_SYSTEMERROR = "InternalError.SystemError"

func (*Client) ModifyInstance

func (c *Client) ModifyInstance(request *ModifyInstanceRequest) (response *ModifyInstanceResponse, err error)

ModifyInstance This API is used to modify instance information. Only the name of an instance can be modified currently.

error code that may be returned:

INTERNALERROR_SYSTEMERROR = "InternalError.SystemError"

func (*Client) ModifyInstanceWithContext

func (c *Client) ModifyInstanceWithContext(ctx context.Context, request *ModifyInstanceRequest) (response *ModifyInstanceResponse, err error)

ModifyInstance This API is used to modify instance information. Only the name of an instance can be modified currently.

error code that may be returned:

INTERNALERROR_SYSTEMERROR = "InternalError.SystemError"

type CreateInstanceByApiRequest

type CreateInstanceByApiRequest struct {
	*tchttp.BaseRequest

	// Instance name.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// Availability zone.
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// Virtual Private Cloud (VPC).
	UserVPCId *string `json:"UserVPCId,omitnil,omitempty" name:"UserVPCId"`

	// Subnet.
	UserSubnetId *string `json:"UserSubnetId,omitnil,omitempty" name:"UserSubnetId"`

	// Billing method.
	ChargeProperties *ChargeProperties `json:"ChargeProperties,omitnil,omitempty" name:"ChargeProperties"`

	// Instance password.
	AdminPassword *string `json:"AdminPassword,omitnil,omitempty" name:"AdminPassword"`

	// Resource information.
	Resources []*ResourceSpecNew `json:"Resources,omitnil,omitempty" name:"Resources"`

	// Tag list.
	Tags *Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Version.
	ProductVersion *string `json:"ProductVersion,omitnil,omitempty" name:"ProductVersion"`
}

func NewCreateInstanceByApiRequest

func NewCreateInstanceByApiRequest() (request *CreateInstanceByApiRequest)

func (*CreateInstanceByApiRequest) FromJsonString

func (r *CreateInstanceByApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateInstanceByApiRequest) ToJsonString

func (r *CreateInstanceByApiRequest) ToJsonString() string

type CreateInstanceByApiRequestParams

type CreateInstanceByApiRequestParams struct {
	// Instance name.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// Availability zone.
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// Virtual Private Cloud (VPC).
	UserVPCId *string `json:"UserVPCId,omitnil,omitempty" name:"UserVPCId"`

	// Subnet.
	UserSubnetId *string `json:"UserSubnetId,omitnil,omitempty" name:"UserSubnetId"`

	// Billing method.
	ChargeProperties *ChargeProperties `json:"ChargeProperties,omitnil,omitempty" name:"ChargeProperties"`

	// Instance password.
	AdminPassword *string `json:"AdminPassword,omitnil,omitempty" name:"AdminPassword"`

	// Resource information.
	Resources []*ResourceSpecNew `json:"Resources,omitnil,omitempty" name:"Resources"`

	// Tag list.
	Tags *Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Version.
	ProductVersion *string `json:"ProductVersion,omitnil,omitempty" name:"ProductVersion"`
}

Predefined struct for user

type CreateInstanceByApiResponse

type CreateInstanceByApiResponse struct {
	*tchttp.BaseResponse
	Response *CreateInstanceByApiResponseParams `json:"Response"`
}

func NewCreateInstanceByApiResponse

func NewCreateInstanceByApiResponse() (response *CreateInstanceByApiResponse)

func (*CreateInstanceByApiResponse) FromJsonString

func (r *CreateInstanceByApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateInstanceByApiResponse) ToJsonString

func (r *CreateInstanceByApiResponse) ToJsonString() string

type CreateInstanceByApiResponseParams

type CreateInstanceByApiResponseParams struct {
	// Process ID.Note: This field may return null, indicating that no valid values can be obtained.
	FlowId *string `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// Instance ID.
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Error message.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceInfoRequest

type DescribeInstanceInfoRequest struct {
	*tchttp.BaseRequest

	// instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceInfoRequest

func NewDescribeInstanceInfoRequest() (request *DescribeInstanceInfoRequest)

func (*DescribeInstanceInfoRequest) FromJsonString

func (r *DescribeInstanceInfoRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceInfoRequest) ToJsonString

func (r *DescribeInstanceInfoRequest) ToJsonString() string

type DescribeInstanceInfoRequestParams

type DescribeInstanceInfoRequestParams struct {
	// instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceInfoResponse

type DescribeInstanceInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceInfoResponseParams `json:"Response"`
}

func NewDescribeInstanceInfoResponse

func NewDescribeInstanceInfoResponse() (response *DescribeInstanceInfoResponse)

func (*DescribeInstanceInfoResponse) FromJsonString

func (r *DescribeInstanceInfoResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceInfoResponse) ToJsonString

func (r *DescribeInstanceInfoResponse) ToJsonString() string

type DescribeInstanceInfoResponseParams

type DescribeInstanceInfoResponseParams struct {
	// Instance simple information
	SimpleInstanceInfo *SimpleInstanceInfo `json:"SimpleInstanceInfo,omitnil,omitempty" name:"SimpleInstanceInfo"`

	// Error Message
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceRequest

type DescribeInstanceRequest struct {
	*tchttp.BaseRequest

	// instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceRequest

func NewDescribeInstanceRequest() (request *DescribeInstanceRequest)

func (*DescribeInstanceRequest) FromJsonString

func (r *DescribeInstanceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceRequest) ToJsonString

func (r *DescribeInstanceRequest) ToJsonString() string

type DescribeInstanceRequestParams

type DescribeInstanceRequestParams struct {
	// instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceResponse

type DescribeInstanceResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceResponseParams `json:"Response"`
}

func NewDescribeInstanceResponse

func NewDescribeInstanceResponse() (response *DescribeInstanceResponse)

func (*DescribeInstanceResponse) FromJsonString

func (r *DescribeInstanceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceResponse) ToJsonString

func (r *DescribeInstanceResponse) ToJsonString() string

type DescribeInstanceResponseParams

type DescribeInstanceResponseParams struct {
	// Instance description information.
	InstanceInfo *InstanceInfo `json:"InstanceInfo,omitnil,omitempty" name:"InstanceInfo"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceStateRequest

type DescribeInstanceStateRequest struct {
	*tchttp.BaseRequest

	//  Instance id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceStateRequest

func NewDescribeInstanceStateRequest() (request *DescribeInstanceStateRequest)

func (*DescribeInstanceStateRequest) FromJsonString

func (r *DescribeInstanceStateRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceStateRequest) ToJsonString

func (r *DescribeInstanceStateRequest) ToJsonString() string

type DescribeInstanceStateRequestParams

type DescribeInstanceStateRequestParams struct {
	//  Instance id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceStateResponse

type DescribeInstanceStateResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceStateResponseParams `json:"Response"`
}

func NewDescribeInstanceStateResponse

func NewDescribeInstanceStateResponse() (response *DescribeInstanceStateResponse)

func (*DescribeInstanceStateResponse) FromJsonString

func (r *DescribeInstanceStateResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceStateResponse) ToJsonString

func (r *DescribeInstanceStateResponse) ToJsonString() string

type DescribeInstanceStateResponseParams

type DescribeInstanceStateResponseParams struct {
	// Instance status. Example: serving.
	InstanceState *string `json:"InstanceState,omitnil,omitempty" name:"InstanceState"`

	// Creation time of instance operation.Note: This field may return null, indicating that no valid values can be obtained.
	FlowCreateTime *string `json:"FlowCreateTime,omitnil,omitempty" name:"FlowCreateTime"`

	// Instance operation name.Note: This field may return null, indicating that no valid values can be obtained.
	FlowName *string `json:"FlowName,omitnil,omitempty" name:"FlowName"`

	// Instance operation progress.Note: This field may return null, indicating that no valid values can be obtained.
	FlowProgress *float64 `json:"FlowProgress,omitnil,omitempty" name:"FlowProgress"`

	// Cluster status description. Example: running.Note: This field may return null, indicating that no valid values can be obtained.
	InstanceStateDesc *string `json:"InstanceStateDesc,omitnil,omitempty" name:"InstanceStateDesc"`

	// Instance process error messages. Example: "Creation failed, insufficient resources."
	// Note: This field may return null, indicating that no valid values can be obtained.
	FlowMsg *string `json:"FlowMsg,omitnil,omitempty" name:"FlowMsg"`

	// The name of the current step. Example: "Purchasing resources."Note: This field may return null, indicating that no valid values can be obtained.
	ProcessName *string `json:"ProcessName,omitnil,omitempty" name:"ProcessName"`

	// Enabling status of the instance backup task.Note: This field may return null, indicating that no valid values can be obtained.
	BackupStatus *int64 `json:"BackupStatus,omitnil,omitempty" name:"BackupStatus"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstancesRequest

type DescribeInstancesRequest struct {
	*tchttp.BaseRequest

	// The name of the Instance ID for the search.
	SearchInstanceId *string `json:"SearchInstanceId,omitnil,omitempty" name:"SearchInstanceId"`

	// The instance name for the search.
	SearchInstanceName *string `json:"SearchInstanceName,omitnil,omitempty" name:"SearchInstanceName"`

	// Pagination parameter. The first page is 0, and the second page is 10.
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Pagination parameter. Pagination step length. It is 10 by default.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Searched tag list.
	SearchTags []*SearchTags `json:"SearchTags,omitnil,omitempty" name:"SearchTags"`
}

func NewDescribeInstancesRequest

func NewDescribeInstancesRequest() (request *DescribeInstancesRequest)

func (*DescribeInstancesRequest) FromJsonString

func (r *DescribeInstancesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesRequest) ToJsonString

func (r *DescribeInstancesRequest) ToJsonString() string

type DescribeInstancesRequestParams

type DescribeInstancesRequestParams struct {
	// The name of the Instance ID for the search.
	SearchInstanceId *string `json:"SearchInstanceId,omitnil,omitempty" name:"SearchInstanceId"`

	// The instance name for the search.
	SearchInstanceName *string `json:"SearchInstanceName,omitnil,omitempty" name:"SearchInstanceName"`

	// Pagination parameter. The first page is 0, and the second page is 10.
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Pagination parameter. Pagination step length. It is 10 by default.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Searched tag list.
	SearchTags []*SearchTags `json:"SearchTags,omitnil,omitempty" name:"SearchTags"`
}

Predefined struct for user

type DescribeInstancesResponse

type DescribeInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstancesResponseParams `json:"Response"`
}

func NewDescribeInstancesResponse

func NewDescribeInstancesResponse() (response *DescribeInstancesResponse)

func (*DescribeInstancesResponse) FromJsonString

func (r *DescribeInstancesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesResponse) ToJsonString

func (r *DescribeInstancesResponse) ToJsonString() string

type DescribeInstancesResponseParams

type DescribeInstancesResponseParams struct {
	// Total number of instances.
	// Note: This field may return null, indicating that no valid values can be obtained.
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// Instance array.
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstancesList []*InstanceInfo `json:"InstancesList,omitnil,omitempty" name:"InstancesList"`

	//  -Note: This field may return null, indicating that no valid values can be obtained.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeSimpleInstancesRequest

type DescribeSimpleInstancesRequest struct {
	*tchttp.BaseRequest

	// Search Instance Id
	SearchInstanceId *string `json:"SearchInstanceId,omitnil,omitempty" name:"SearchInstanceId"`

	// Search Instance Name
	SearchInstanceName *string `json:"SearchInstanceName,omitnil,omitempty" name:"SearchInstanceName"`

	//
	// Offset
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Limit
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Search Tags
	SearchTags []*string `json:"SearchTags,omitnil,omitempty" name:"SearchTags"`
}

func NewDescribeSimpleInstancesRequest

func NewDescribeSimpleInstancesRequest() (request *DescribeSimpleInstancesRequest)

func (*DescribeSimpleInstancesRequest) FromJsonString

func (r *DescribeSimpleInstancesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSimpleInstancesRequest) ToJsonString

func (r *DescribeSimpleInstancesRequest) ToJsonString() string

type DescribeSimpleInstancesRequestParams

type DescribeSimpleInstancesRequestParams struct {
	// Search Instance Id
	SearchInstanceId *string `json:"SearchInstanceId,omitnil,omitempty" name:"SearchInstanceId"`

	// Search Instance Name
	SearchInstanceName *string `json:"SearchInstanceName,omitnil,omitempty" name:"SearchInstanceName"`

	//
	// Offset
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Limit
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Search Tags
	SearchTags []*string `json:"SearchTags,omitnil,omitempty" name:"SearchTags"`
}

Predefined struct for user

type DescribeSimpleInstancesResponse

type DescribeSimpleInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSimpleInstancesResponseParams `json:"Response"`
}

func NewDescribeSimpleInstancesResponse

func NewDescribeSimpleInstancesResponse() (response *DescribeSimpleInstancesResponse)

func (*DescribeSimpleInstancesResponse) FromJsonString

func (r *DescribeSimpleInstancesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSimpleInstancesResponse) ToJsonString

func (r *DescribeSimpleInstancesResponse) ToJsonString() string

type DescribeSimpleInstancesResponseParams

type DescribeSimpleInstancesResponseParams struct {
	// Total Count
	// Note: This field may return null, indicating that no valid values can be obtained.
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// Instances List
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstancesList []*InstanceSimpleInfoNew `json:"InstancesList,omitnil,omitempty" name:"InstancesList"`

	//  Error Message
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DestroyInstanceByApiRequest

type DestroyInstanceByApiRequest struct {
	*tchttp.BaseRequest

	// Instance id. Example: "cdwpg-xxxx".
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDestroyInstanceByApiRequest

func NewDestroyInstanceByApiRequest() (request *DestroyInstanceByApiRequest)

func (*DestroyInstanceByApiRequest) FromJsonString

func (r *DestroyInstanceByApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DestroyInstanceByApiRequest) ToJsonString

func (r *DestroyInstanceByApiRequest) ToJsonString() string

type DestroyInstanceByApiRequestParams

type DestroyInstanceByApiRequestParams struct {
	// Instance id. Example: "cdwpg-xxxx".
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DestroyInstanceByApiResponse

type DestroyInstanceByApiResponse struct {
	*tchttp.BaseResponse
	Response *DestroyInstanceByApiResponseParams `json:"Response"`
}

func NewDestroyInstanceByApiResponse

func NewDestroyInstanceByApiResponse() (response *DestroyInstanceByApiResponse)

func (*DestroyInstanceByApiResponse) FromJsonString

func (r *DestroyInstanceByApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DestroyInstanceByApiResponse) ToJsonString

func (r *DestroyInstanceByApiResponse) ToJsonString() string

type DestroyInstanceByApiResponseParams

type DestroyInstanceByApiResponseParams struct {
	// Destroy  process ID.
	FlowId *string `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// Error message.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DiskSpecPlus

type DiskSpecPlus struct {
	// Disk Count
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiskCount *int64 `json:"DiskCount,omitnil,omitempty" name:"DiskCount"`

	// Max Disk Size
	// Note: This field may return null, indicating that no valid values can be obtained.
	MaxDiskSize *int64 `json:"MaxDiskSize,omitnil,omitempty" name:"MaxDiskSize"`

	// Min Disk Size
	// Note: This field may return null, indicating that no valid values can be obtained.
	MinDiskSize *int64 `json:"MinDiskSize,omitnil,omitempty" name:"MinDiskSize"`

	// Disk Type
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Disk Description
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiskDesc *string `json:"DiskDesc,omitnil,omitempty" name:"DiskDesc"`

	// Cvm Class
	// Note: This field may return null, indicating that no valid values can be obtained.
	CvmClass *string `json:"CvmClass,omitnil,omitempty" name:"CvmClass"`
}

type InstanceInfo

type InstanceInfo struct {
	// Instance ID
	// Note: This field may return null, indicating that no valid values can be obtained.
	ID *int64 `json:"ID,omitnil,omitempty" name:"ID"`

	// cn/dn or others.Note: This field may return null, indicating that no valid values can be obtained.
	InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// Instance Name
	// .Note: This field may return null, indicating that no valid values can be obtained.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// Instance Status ,such as  2
	// Note: This field may return null, indicating that no valid values can be obtained.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Instance Status  Description ,such as Running.
	// Note: This field may return null, indicating that no valid values can be obtained.
	StatusDesc *string `json:"StatusDesc,omitnil,omitempty" name:"StatusDesc"`

	// Instance State Infomation
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceStateInfo *InstanceStateInfo `json:"InstanceStateInfo,omitnil,omitempty" name:"InstanceStateInfo"`

	// Instance ID
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceID *string `json:"InstanceID,omitnil,omitempty" name:"InstanceID"`

	// CreateTime ,such as 2022-09-05 20:00:01
	// Note: This field may return null, indicating that no valid values can be obtained.
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// Region ,such as ap-chongqing.Note: This field may return null, indicating that no valid values can be obtained.
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// Zone : This field may return null, indicating that no valid values can be obtained.
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// Region.Note: This field may return null, indicating that no valid values can be obtained.
	RegionDesc *string `json:"RegionDesc,omitnil,omitempty" name:"RegionDesc"`

	// Zone.Note: This field may return null, indicating that no valid values can be obtained.
	ZoneDesc *string `json:"ZoneDesc,omitnil,omitempty" name:"ZoneDesc"`

	// Tag.Note: This field may return null, indicating that no valid values can be obtained.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Version.Note: This field may return null, indicating that no valid values can be obtained.
	Version *string `json:"Version,omitnil,omitempty" name:"Version"`

	// Character set.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Charset *string `json:"Charset,omitnil,omitempty" name:"Charset"`

	// CN node list.
	// Note: This field may return null, indicating that no valid values can be obtained.
	CNNodes []*InstanceNodeGroup `json:"CNNodes,omitnil,omitempty" name:"CNNodes"`

	// DN node list.
	// Note: This field may return null, indicating that no valid values can be obtained.
	DNNodes []*InstanceNodeGroup `json:"DNNodes,omitnil,omitempty" name:"DNNodes"`

	//  Region Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	RegionId *int64 `json:"RegionId,omitnil,omitempty" name:"RegionId"`

	// Zone Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	ZoneId *int64 `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// Vpc Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// Subnet Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// Expire Time
	// Note: This field may return null, indicating that no valid values can be obtained.
	ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// Pay Mode
	// Note: This field may return null, indicating that no valid values can be obtained.
	PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// Renew Flag
	// Note: This field may return null, indicating that no valid values can be obtained.
	RenewFlag *bool `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`

	// Instance Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Access information.
	// Note: This field may return null, indicating that no valid values can be obtained.
	AccessDetails []*AccessInfo `json:"AccessDetails,omitnil,omitempty" name:"AccessDetails"`
}

type InstanceNodeGroup

type InstanceNodeGroup struct {
	// Spec Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	SpecName *string `json:"SpecName,omitnil,omitempty" name:"SpecName"`

	// Data Disk
	// Note: This field may return null, indicating that no valid values can be obtained.
	DataDisk *DiskSpecPlus `json:"DataDisk,omitnil,omitempty" name:"DataDisk"`

	// Cvm Count
	// Note: This field may return null, indicating that no valid values can be obtained.
	CvmCount *int64 `json:"CvmCount,omitnil,omitempty" name:"CvmCount"`
}

type InstanceSimpleInfoNew

type InstanceSimpleInfoNew struct {
	// ID
	// Note: This field may return null, indicating that no valid values can be obtained.
	ID *int64 `json:"ID,omitnil,omitempty" name:"ID"`

	// Instance Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Instance Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// Version
	// Note: This field may return null, indicating that no valid values can be obtained.
	Version *string `json:"Version,omitnil,omitempty" name:"Version"`

	// Region
	// Note: This field may return null, indicating that no valid values can be obtained.
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// Region Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	RegionId *int64 `json:"RegionId,omitnil,omitempty" name:"RegionId"`

	// Region Desc
	// Note: This field may return null, indicating that no valid values can be obtained.
	RegionDesc *string `json:"RegionDesc,omitnil,omitempty" name:"RegionDesc"`

	// Zone
	// Note: This field may return null, indicating that no valid values can be obtained.
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// Zone Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	ZoneId *int64 `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// Zone Desc
	// Note: This field may return null, indicating that no valid values can be obtained.
	ZoneDesc *string `json:"ZoneDesc,omitnil,omitempty" name:"ZoneDesc"`

	// Vpc Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// Subnet Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// CreateTime
	// Note: This field may return null, indicating that no valid values can be obtained.
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// ExpireTime
	// Note: This field may return null, indicating that no valid values can be obtained.
	ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// Access Infomation
	// Note: This field may return null, indicating that no valid values can be obtained.
	AccessInfo *string `json:"AccessInfo,omitnil,omitempty" name:"AccessInfo"`

	// Pay Mode
	// Note: This field may return null, indicating that no valid values can be obtained.
	PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// Renew Flag
	// Note: This field may return null, indicating that no valid values can be obtained.
	RenewFlag *bool `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`
}

type InstanceStateInfo

type InstanceStateInfo struct {
	// Instance status. Example: serving.
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceState *string `json:"InstanceState,omitnil,omitempty" name:"InstanceState"`

	// Creation time of instance operation.
	// Note: This field may return null, indicating that no valid values can be obtained.
	FlowCreateTime *string `json:"FlowCreateTime,omitnil,omitempty" name:"FlowCreateTime"`

	// Instance operation name.
	// Note: This field may return null, indicating that no valid values can be obtained.
	FlowName *string `json:"FlowName,omitnil,omitempty" name:"FlowName"`

	// Instance operation progress.
	// Note: This field may return null, indicating that no valid values can be obtained.
	FlowProgress *int64 `json:"FlowProgress,omitnil,omitempty" name:"FlowProgress"`

	// Instance status description. Example: running.
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceStateDesc *string `json:"InstanceStateDesc,omitnil,omitempty" name:"InstanceStateDesc"`

	// Instance process error messages. Example: "Creation failed, insufficient resources."
	// Note: This field may return null, indicating that no valid values can be obtained.
	FlowMsg *string `json:"FlowMsg,omitnil,omitempty" name:"FlowMsg"`

	// The name of the current step. Example: "Purchasing resources."
	// Note: This field may return null, indicating that no valid values can be obtained.
	ProcessName *string `json:"ProcessName,omitnil,omitempty" name:"ProcessName"`

	// Indicates whether there is a backup task in the instance. 1 indicates yes and 0 indicates no.
	// Note: This field may return null, indicating that no valid values can be obtained.
	BackupStatus *int64 `json:"BackupStatus,omitnil,omitempty" name:"BackupStatus"`

	// Request Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`

	// Backup Open Status
	// Note: This field may return null, indicating that no valid values can be obtained.
	BackupOpenStatus *int64 `json:"BackupOpenStatus,omitnil,omitempty" name:"BackupOpenStatus"`
}

type ModifyInstanceRequest

type ModifyInstanceRequest struct {
	*tchttp.BaseRequest

	// Instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Name of the newly modified instance.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`
}

func NewModifyInstanceRequest

func NewModifyInstanceRequest() (request *ModifyInstanceRequest)

func (*ModifyInstanceRequest) FromJsonString

func (r *ModifyInstanceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyInstanceRequest) ToJsonString

func (r *ModifyInstanceRequest) ToJsonString() string

type ModifyInstanceRequestParams

type ModifyInstanceRequestParams struct {
	// Instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Name of the newly modified instance.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`
}

Predefined struct for user

type ModifyInstanceResponse

type ModifyInstanceResponse struct {
	*tchttp.BaseResponse
	Response *ModifyInstanceResponseParams `json:"Response"`
}

func NewModifyInstanceResponse

func NewModifyInstanceResponse() (response *ModifyInstanceResponse)

func (*ModifyInstanceResponse) FromJsonString

func (r *ModifyInstanceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyInstanceResponse) ToJsonString

func (r *ModifyInstanceResponse) ToJsonString() string

type ModifyInstanceResponseParams

type ModifyInstanceResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ResourceInfo

type ResourceInfo struct {
	// Resource name.
	// Note: This field may return null, indicating that no valid values can be obtained.
	SpecName *string `json:"SpecName,omitnil,omitempty" name:"SpecName"`

	// Resource count.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Count *int64 `json:"Count,omitnil,omitempty" name:"Count"`

	// Disk information.
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiskSpec *CBSSpecInfo `json:"DiskSpec,omitnil,omitempty" name:"DiskSpec"`

	// Resource type.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`
}

type ResourceSpecNew

type ResourceSpecNew struct {
	// Resource name.
	SpecName *string `json:"SpecName,omitnil,omitempty" name:"SpecName"`

	// Resource count.
	Count *int64 `json:"Count,omitnil,omitempty" name:"Count"`

	// Disk information.
	DiskSpec *CBSSpec `json:"DiskSpec,omitnil,omitempty" name:"DiskSpec"`

	// Resource type, DATA.
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`
}

type SearchTags

type SearchTags struct {
	// Tag key.
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// Tag value.
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`

	// 1 means only the Tag key is entered without a value, and 0 means both the key and the value are entered.
	AllValue *int64 `json:"AllValue,omitnil,omitempty" name:"AllValue"`
}

type SimpleInstanceInfo

type SimpleInstanceInfo struct {
	// ID
	// Note: This field may return null, indicating that no valid values can be obtained.
	ID *int64 `json:"ID,omitnil,omitempty" name:"ID"`

	// Instance Id
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Instance Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// Version
	// Note: This field may return null, indicating that no valid values can be obtained.
	Version *string `json:"Version,omitnil,omitempty" name:"Version"`

	// Region
	// Note: This field may return null, indicating that no valid values can be obtained.
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// Zone
	// Note: This field may return null, indicating that no valid values can be obtained.
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// User VPC ID
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserVPCID *string `json:"UserVPCID,omitnil,omitempty" name:"UserVPCID"`

	// User Subnet ID
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserSubnetID *string `json:"UserSubnetID,omitnil,omitempty" name:"UserSubnetID"`

	// CreateTime
	// Note: This field may return null, indicating that no valid values can be obtained.
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// ExpireTime
	// Note: This field may return null, indicating that no valid values can be obtained.
	ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// Access Infomation
	// Note: This field may return null, indicating that no valid values can be obtained.
	AccessInfo *string `json:"AccessInfo,omitnil,omitempty" name:"AccessInfo"`

	// Renew Flag
	// Note: This field may return null, indicating that no valid values can be obtained.
	RenewFlag *int64 `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`

	// Charge Properties
	// Note: This field may return null, indicating that no valid values can be obtained.
	ChargeProperties *ChargeProperties `json:"ChargeProperties,omitnil,omitempty" name:"ChargeProperties"`

	// Resources
	// Note: This field may return null, indicating that no valid values can be obtained.
	Resources []*ResourceInfo `json:"Resources,omitnil,omitempty" name:"Resources"`

	// Tags
	// Note: This field may return null, indicating that no valid values can be obtained.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Status
	// Note: This field may return null, indicating that no valid values can be obtained.
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`
}

type Tag

type Tag struct {
	// Tag key.
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// Tag value.
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL