v20180416

package
v3.0.408+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 28, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error
	AUTHFAILURE = "AuthFailure"

	// Unauthorized operation.
	AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"

	// An error occurred with the cluster resource quota limit.
	FAILEDOPERATION_CLUSTERRESOURCELIMITERROR = "FailedOperation.ClusterResourceLimitError"

	// Failed to query the number of disks of the node
	FAILEDOPERATION_DISKCOUNTPARAMERROR = "FailedOperation.DiskCountParamError"

	// Incorrect cluster status
	FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"

	// No replicas for indexes in the cluster.
	FAILEDOPERATION_ERRORCLUSTERSTATENOREPLICATION = "FailedOperation.ErrorClusterStateNoReplication"

	// The cluster is unhealthy.
	FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"

	// No credit card or PayPal account is linked to the current account. Unable to make a payment.
	FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"

	// Unverified user.
	FAILEDOPERATION_NOTAUTHENTICATED = "FailedOperation.NotAuthenticated"

	// Cannot adjust the node configuration and disk capacity reversely.
	FAILEDOPERATION_UNSUPPORTREVERSEREGULATIONNODETYPEANDDISK = "FailedOperation.UnsupportReverseRegulationNodeTypeAndDisk"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Invalid parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Resource is in use.
	RESOURCEINUSE = "ResourceInUse"

	// Insufficient resource.
	RESOURCEINSUFFICIENT = "ResourceInsufficient"

	// Insufficient account balance.
	RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"

	// Dedicated master node resources in the hidden availability zone are insufficient.
	RESOURCEINSUFFICIENT_HIDDENZONE = "ResourceInsufficient.HiddenZone"

	// Insufficient number of remaining subnet IPs.
	RESOURCEINSUFFICIENT_SUBNET = "ResourceInsufficient.Subnet"

	// The resource does not exist.
	RESOURCENOTFOUND = "ResourceNotFound"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source 
const APIVersion = "2018-04-16"

Variables

This section is empty.

Functions

This section is empty.

Types

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) CreateInstance 

func (c *Client) CreateInstance(request *CreateInstanceRequest) (response *CreateInstanceResponse, err error)

CreateInstance This API is used to create an ES cluster instance with the specified specification.

error code that may be returned: 

FAILEDOPERATION_CLUSTERRESOURCELIMITERROR = "FailedOperation.ClusterResourceLimitError"
FAILEDOPERATION_DISKCOUNTPARAMERROR = "FailedOperation.DiskCountParamError"
FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
FAILEDOPERATION_NOTAUTHENTICATED = "FailedOperation.NotAuthenticated"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
RESOURCEINSUFFICIENT_HIDDENZONE = "ResourceInsufficient.HiddenZone"
RESOURCEINSUFFICIENT_SUBNET = "ResourceInsufficient.Subnet"

func (*Client) CreateInstanceWithContext 

func (c *Client) CreateInstanceWithContext(ctx context.Context, request *CreateInstanceRequest) (response *CreateInstanceResponse, err error)

CreateInstance This API is used to create an ES cluster instance with the specified specification.

error code that may be returned: 

FAILEDOPERATION_CLUSTERRESOURCELIMITERROR = "FailedOperation.ClusterResourceLimitError"
FAILEDOPERATION_DISKCOUNTPARAMERROR = "FailedOperation.DiskCountParamError"
FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
FAILEDOPERATION_NOTAUTHENTICATED = "FailedOperation.NotAuthenticated"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
RESOURCEINSUFFICIENT_HIDDENZONE = "ResourceInsufficient.HiddenZone"
RESOURCEINSUFFICIENT_SUBNET = "ResourceInsufficient.Subnet"

func (*Client) DeleteInstance 

func (c *Client) DeleteInstance(request *DeleteInstanceRequest) (response *DeleteInstanceResponse, err error)

DeleteInstance This API is used to terminate a cluster instance.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteInstanceWithContext 

func (c *Client) DeleteInstanceWithContext(ctx context.Context, request *DeleteInstanceRequest) (response *DeleteInstanceResponse, err error)

DeleteInstance This API is used to terminate a cluster instance.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeInstanceLogs 

func (c *Client) DescribeInstanceLogs(request *DescribeInstanceLogsRequest) (response *DescribeInstanceLogsResponse, err error)

DescribeInstanceLogs This API is used to query the eligible ES cluster logs in the current region.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) DescribeInstanceLogsWithContext 

func (c *Client) DescribeInstanceLogsWithContext(ctx context.Context, request *DescribeInstanceLogsRequest) (response *DescribeInstanceLogsResponse, err error)

DescribeInstanceLogs This API is used to query the eligible ES cluster logs in the current region.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) DescribeInstanceOperations 

func (c *Client) DescribeInstanceOperations(request *DescribeInstanceOperationsRequest) (response *DescribeInstanceOperationsResponse, err error)

DescribeInstanceOperations This API is used to query the operation history of an instance by specified criteria.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"

func (*Client) DescribeInstanceOperationsWithContext 

func (c *Client) DescribeInstanceOperationsWithContext(ctx context.Context, request *DescribeInstanceOperationsRequest) (response *DescribeInstanceOperationsResponse, err error)

DescribeInstanceOperations This API is used to query the operation history of an instance by specified criteria.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"

func (*Client) DescribeInstances 

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

DescribeInstances This API is used to query all eligible instances in the current region under the current account.

error code that may be returned: 

AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) DescribeInstancesWithContext 

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

DescribeInstances This API is used to query all eligible instances in the current region under the current account.

error code that may be returned: 

AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) DescribeViews 

func (c *Client) DescribeViews(request *DescribeViewsRequest) (response *DescribeViewsResponse, err error)

DescribeViews This API is used to query view data from three dimensions: cluster, node, and Kibana.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"

func (*Client) DescribeViewsWithContext 

func (c *Client) DescribeViewsWithContext(ctx context.Context, request *DescribeViewsRequest) (response *DescribeViewsResponse, err error)

DescribeViews This API is used to query view data from three dimensions: cluster, node, and Kibana.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"

func (*Client) GetRequestTargetNodeTypes 

func (c *Client) GetRequestTargetNodeTypes(request *GetRequestTargetNodeTypesRequest) (response *GetRequestTargetNodeTypesResponse, err error)

GetRequestTargetNodeTypes This API is used to get the node types used to receive client requests.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetRequestTargetNodeTypesWithContext 

func (c *Client) GetRequestTargetNodeTypesWithContext(ctx context.Context, request *GetRequestTargetNodeTypesRequest) (response *GetRequestTargetNodeTypesResponse, err error)

GetRequestTargetNodeTypes This API is used to get the node types used to receive client requests.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) RestartInstance 

func (c *Client) RestartInstance(request *RestartInstanceRequest) (response *RestartInstanceResponse, err error)

RestartInstance This API is used to restart an ES cluster instance (for operations such as system update).

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"

func (*Client) RestartInstanceWithContext 

func (c *Client) RestartInstanceWithContext(ctx context.Context, request *RestartInstanceRequest) (response *RestartInstanceResponse, err error)

RestartInstance This API is used to restart an ES cluster instance (for operations such as system update).

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"

func (*Client) RestartKibana 

func (c *Client) RestartKibana(request *RestartKibanaRequest) (response *RestartKibanaResponse, err error)

RestartKibana This API is used to restart Kibana.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"

func (*Client) RestartKibanaWithContext 

func (c *Client) RestartKibanaWithContext(ctx context.Context, request *RestartKibanaRequest) (response *RestartKibanaResponse, err error)

RestartKibana This API is used to restart Kibana.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"

func (*Client) RestartNodes 

func (c *Client) RestartNodes(request *RestartNodesRequest) (response *RestartNodesResponse, err error)

RestartNodes This API is used to restart cluster nodes.

error code that may be returned: 

FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) RestartNodesWithContext 

func (c *Client) RestartNodesWithContext(ctx context.Context, request *RestartNodesRequest) (response *RestartNodesResponse, err error)

RestartNodes This API is used to restart cluster nodes.

error code that may be returned: 

FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateInstance 

func (c *Client) UpdateInstance(request *UpdateInstanceRequest) (response *UpdateInstanceResponse, err error)

UpdateInstance This API is used for operations such as modifying node specification, renaming an instance, modifying configuration, resetting password, and setting Kibana blocklist/allowlist. `InstanceId` is required, while `ForceRestart` is optional. Other parameters or parameter combinations and their meanings are as follows:

- InstanceName: renames an instance (only for instance identification)

- NodeInfoList: modifies node configuration (horizontally scaling nodes, vertically scaling nodes, adding primary nodes, adding cold nodes, etc.)

- EsConfig: modifies cluster configuration

- Password: changes the password of the default user "elastic"

- EsAcl: modifies the ACL

- CosBackUp: sets auto-backup to COS for a cluster

Only one of the parameters or parameter combinations above can be passed in at a time, while passing fewer or more ones will cause the request to fail.

error code that may be returned: 

FAILEDOPERATION_CLUSTERRESOURCELIMITERROR = "FailedOperation.ClusterResourceLimitError"
FAILEDOPERATION_DISKCOUNTPARAMERROR = "FailedOperation.DiskCountParamError"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
FAILEDOPERATION_UNSUPPORTREVERSEREGULATIONNODETYPEANDDISK = "FailedOperation.UnsupportReverseRegulationNodeTypeAndDisk"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
RESOURCEINSUFFICIENT_SUBNET = "ResourceInsufficient.Subnet"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateInstanceWithContext 

func (c *Client) UpdateInstanceWithContext(ctx context.Context, request *UpdateInstanceRequest) (response *UpdateInstanceResponse, err error)

UpdateInstance This API is used for operations such as modifying node specification, renaming an instance, modifying configuration, resetting password, and setting Kibana blocklist/allowlist. `InstanceId` is required, while `ForceRestart` is optional. Other parameters or parameter combinations and their meanings are as follows:

- InstanceName: renames an instance (only for instance identification)

- NodeInfoList: modifies node configuration (horizontally scaling nodes, vertically scaling nodes, adding primary nodes, adding cold nodes, etc.)

- EsConfig: modifies cluster configuration

- Password: changes the password of the default user "elastic"

- EsAcl: modifies the ACL

- CosBackUp: sets auto-backup to COS for a cluster

Only one of the parameters or parameter combinations above can be passed in at a time, while passing fewer or more ones will cause the request to fail.

error code that may be returned: 

FAILEDOPERATION_CLUSTERRESOURCELIMITERROR = "FailedOperation.ClusterResourceLimitError"
FAILEDOPERATION_DISKCOUNTPARAMERROR = "FailedOperation.DiskCountParamError"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
FAILEDOPERATION_UNSUPPORTREVERSEREGULATIONNODETYPEANDDISK = "FailedOperation.UnsupportReverseRegulationNodeTypeAndDisk"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
RESOURCEINSUFFICIENT_SUBNET = "ResourceInsufficient.Subnet"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdatePlugins 

func (c *Client) UpdatePlugins(request *UpdatePluginsRequest) (response *UpdatePluginsResponse, err error)

UpdatePlugins This API is used to change the list of plugins.

error code that may be returned: 

FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATENOREPLICATION = "FailedOperation.ErrorClusterStateNoReplication"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdatePluginsWithContext 

func (c *Client) UpdatePluginsWithContext(ctx context.Context, request *UpdatePluginsRequest) (response *UpdatePluginsResponse, err error)

UpdatePlugins This API is used to change the list of plugins.

error code that may be returned: 

FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATENOREPLICATION = "FailedOperation.ErrorClusterStateNoReplication"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateRequestTargetNodeTypes 

func (c *Client) UpdateRequestTargetNodeTypes(request *UpdateRequestTargetNodeTypesRequest) (response *UpdateRequestTargetNodeTypesResponse, err error)

UpdateRequestTargetNodeTypes This API is used to update the node types used to receive client requests.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateRequestTargetNodeTypesWithContext 

func (c *Client) UpdateRequestTargetNodeTypesWithContext(ctx context.Context, request *UpdateRequestTargetNodeTypesRequest) (response *UpdateRequestTargetNodeTypesResponse, err error)

UpdateRequestTargetNodeTypes This API is used to update the node types used to receive client requests.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpgradeInstance 

func (c *Client) UpgradeInstance(request *UpgradeInstanceRequest) (response *UpgradeInstanceResponse, err error)

UpgradeInstance This API is used to upgrade ES cluster version

error code that may be returned: 

FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
RESOURCEINSUFFICIENT_SUBNET = "ResourceInsufficient.Subnet"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpgradeInstanceWithContext 

func (c *Client) UpgradeInstanceWithContext(ctx context.Context, request *UpgradeInstanceRequest) (response *UpgradeInstanceResponse, err error)

UpgradeInstance This API is used to upgrade ES cluster version

error code that may be returned: 

FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
RESOURCEINSUFFICIENT_SUBNET = "ResourceInsufficient.Subnet"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpgradeLicense 

func (c *Client) UpgradeLicense(request *UpgradeLicenseRequest) (response *UpgradeLicenseResponse, err error)

UpgradeLicense This API is used to upgrade ES X-Pack.

error code that may be returned: 

FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpgradeLicenseWithContext 

func (c *Client) UpgradeLicenseWithContext(ctx context.Context, request *UpgradeLicenseRequest) (response *UpgradeLicenseResponse, err error)

UpgradeLicense This API is used to upgrade ES X-Pack.

error code that may be returned: 

FAILEDOPERATION_NOPAYMENT = "FailedOperation.NoPayment"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_BALANCE = "ResourceInsufficient.Balance"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

type ClusterView 

type ClusterView struct {

	// Cluster health status
	Health *float64 `json:"Health,omitempty" name:"Health"`

	// Whether the cluster is visible
	Visible *float64 `json:"Visible,omitempty" name:"Visible"`

	// Whether the cluster encounters circuit breaking
	Break *float64 `json:"Break,omitempty" name:"Break"`

	// Average disk usage
	AvgDiskUsage *float64 `json:"AvgDiskUsage,omitempty" name:"AvgDiskUsage"`

	// Average memory usage
	AvgMemUsage *float64 `json:"AvgMemUsage,omitempty" name:"AvgMemUsage"`

	// Average CPU usage
	AvgCpuUsage *float64 `json:"AvgCpuUsage,omitempty" name:"AvgCpuUsage"`

	// Total disk size of the cluster
	TotalDiskSize *uint64 `json:"TotalDiskSize,omitempty" name:"TotalDiskSize"`

	// Types of nodes to receive client requests
	TargetNodeTypes []*string `json:"TargetNodeTypes,omitempty" name:"TargetNodeTypes"`

	// Number of online nodes
	NodeNum *int64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Total number of nodes
	TotalNodeNum *int64 `json:"TotalNodeNum,omitempty" name:"TotalNodeNum"`

	// Number of data nodes
	DataNodeNum *int64 `json:"DataNodeNum,omitempty" name:"DataNodeNum"`

	// Number of indices
	IndexNum *int64 `json:"IndexNum,omitempty" name:"IndexNum"`

	// Number of documents
	DocNum *int64 `json:"DocNum,omitempty" name:"DocNum"`

	// Used disk size (in bytes)
	DiskUsedInBytes *int64 `json:"DiskUsedInBytes,omitempty" name:"DiskUsedInBytes"`

	// Number of shards
	ShardNum *int64 `json:"ShardNum,omitempty" name:"ShardNum"`

	// Number of primary shards
	PrimaryShardNum *int64 `json:"PrimaryShardNum,omitempty" name:"PrimaryShardNum"`

	// Number of relocating shards
	RelocatingShardNum *int64 `json:"RelocatingShardNum,omitempty" name:"RelocatingShardNum"`

	// Number of initializing shards
	InitializingShardNum *int64 `json:"InitializingShardNum,omitempty" name:"InitializingShardNum"`

	// Number of unassigned shards
	UnassignedShardNum *int64 `json:"UnassignedShardNum,omitempty" name:"UnassignedShardNum"`

	// Total COS storage of an enterprise cluster, in GB
	TotalCosStorage *int64 `json:"TotalCosStorage,omitempty" name:"TotalCosStorage"`

	// Name of the COS bucket that stores searchable snapshots of an enterprise cluster
	// Note: This field may return `null`, indicating that no valid value was found.
	SearchableSnapshotCosBucket *string `json:"SearchableSnapshotCosBucket,omitempty" name:"SearchableSnapshotCosBucket"`

	// COS app ID of the searchable snapshots of an enterprise cluster
	// Note: This field may return `null`, indicating that no valid value was found.
	SearchableSnapshotCosAppId *string `json:"SearchableSnapshotCosAppId,omitempty" name:"SearchableSnapshotCosAppId"`
}

type CosBackup 

type CosBackup struct {

	// Whether to enable auto-backup to COS
	IsAutoBackup *bool `json:"IsAutoBackup,omitempty" name:"IsAutoBackup"`

	// Auto-backup time (accurate down to the hour), such as "22:00"
	BackupTime *string `json:"BackupTime,omitempty" name:"BackupTime"`
}

type CreateInstanceRequest 

type CreateInstanceRequest struct {
	*tchttp.BaseRequest

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

	// Instance version. Valid values: `5.6.4`, `6.4.3`, `6.8.2`, `7.5.1`, `7.10.1`
	EsVersion *string `json:"EsVersion,omitempty" name:"EsVersion"`

	// VPC ID
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// Subnet ID
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// Access password, which must contain 8 to 16 characters, and include at least two of the following three types of characters: [a-z,A-Z], [0-9] and [-!@#$%&^*+=_:;,.?]
	Password *string `json:"Password,omitempty" name:"Password"`

	// Instance name, which can contain 1 to 50 English letters, Chinese characters, digits, dashes (-), or underscores (_)
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Number of nodes (2-50)
	NodeNum *uint64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Billing mode <li>POSTPAID_BY_HOUR: Pay-as-you-go hourly </li>Default value: POSTPAID_BY_HOUR
	ChargeType *string `json:"ChargeType,omitempty" name:"ChargeType"`

	// This parameter is not used on the global website
	ChargePeriod *uint64 `json:"ChargePeriod,omitempty" name:"ChargePeriod"`

	// This parameter is not used on the global website
	RenewFlag *string `json:"RenewFlag,omitempty" name:"RenewFlag"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Node specification <li>ES.S1.SMALL2: 1-core 2 GB </li><li>ES.S1.MEDIUM4: 2-core 4 GB </li><li>ES.S1.MEDIUM8: 2-core 8 GB </li><li>ES.S1.LARGE16: 4-core 16 GB </li><li>ES.S1.2XLARGE32: 8-core 32 GB </li><li>ES.S1.4XLARGE32: 16-core 32 GB </li><li>ES.S1.4XLARGE64: 16-core 64 GB </li>
	NodeType *string `json:"NodeType,omitempty" name:"NodeType"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Node storage type <li>CLOUD_SSD: SSD cloud storage </li><li>CLOUD_PREMIUM: premium cloud storage </li>Default value: CLOUD_SSD
	DiskType *string `json:"DiskType,omitempty" name:"DiskType"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Node disk size in GB
	DiskSize *uint64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// This parameter is not used on the global website
	TimeUnit *string `json:"TimeUnit,omitempty" name:"TimeUnit"`

	// Whether to automatically use vouchers <li>0: No </li><li>1: Yes </li>Default value: 0
	AutoVoucher *int64 `json:"AutoVoucher,omitempty" name:"AutoVoucher"`

	// List of voucher IDs (only one voucher can be specified at a time currently)
	VoucherIds []*string `json:"VoucherIds,omitempty" name:"VoucherIds"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Whether to create a dedicated primary node <li>true: yes </li><li>false: no </li>Default value: false
	EnableDedicatedMaster *bool `json:"EnableDedicatedMaster,omitempty" name:"EnableDedicatedMaster"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Number of dedicated primary nodes (only 3 and 5 are supported. This value must be passed in if `EnableDedicatedMaster` is `true`)
	MasterNodeNum *uint64 `json:"MasterNodeNum,omitempty" name:"MasterNodeNum"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Dedicated primary node type, which must be passed in if `EnableDedicatedMaster` is `true` <li>ES.S1.SMALL2: 1-core 2 GB</li><li>ES.S1.MEDIUM4: 2-core 4 GB</li><li>ES.S1.MEDIUM8: 2-core 8 GB</li><li>ES.S1.LARGE16: 4-core 16 GB</li><li>ES.S1.2XLARGE32: 8-core 32 GB</li><li>ES.S1.4XLARGE32: 16-core 32 GB</li><li>ES.S1.4XLARGE64: 16-core 64 GB</li>
	MasterNodeType *string `json:"MasterNodeType,omitempty" name:"MasterNodeType"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Dedicated primary node disk size in GB, which is optional. If passed in, it can only be 50 and cannot be customized currently
	MasterNodeDiskSize *uint64 `json:"MasterNodeDiskSize,omitempty" name:"MasterNodeDiskSize"`

	// ClusterName in the cluster configuration file, which is the instance ID by default and currently cannot be customized
	ClusterNameInConf *string `json:"ClusterNameInConf,omitempty" name:"ClusterNameInConf"`

	// Cluster deployment mode <li>0: single-AZ deployment </li><li>1: multi-AZ deployment </li>Default value: 0
	DeployMode *uint64 `json:"DeployMode,omitempty" name:"DeployMode"`

	// Details of AZs in multi-AZ deployment mode (which is required when DeployMode is 1)
	MultiZoneInfo []*ZoneDetail `json:"MultiZoneInfo,omitempty" name:"MultiZoneInfo"`

	// License type <li>oss: Open Source Edition </li><li>basic: Basic Edition </li><li>platinum: Platinum Edition </li>Default value: Platinum
	LicenseType *string `json:"LicenseType,omitempty" name:"LicenseType"`

	// Node information list, which is used to describe the specification information of various types of nodes in the cluster, such as node type, node quantity, node specification, disk type, and disk size
	NodeInfoList []*NodeInfo `json:"NodeInfoList,omitempty" name:"NodeInfoList"`

	// Node tag information list
	TagList []*TagInfo `json:"TagList,omitempty" name:"TagList"`

	// Whether to enable X-Pack security authentication in Basic Edition 6.8 (and above) <li>1: disabled </li><li>2: enabled</li>
	BasicSecurityType *uint64 `json:"BasicSecurityType,omitempty" name:"BasicSecurityType"`

	// Scenario template type. 0: not enabled; 1: general; 2: log; 3: search
	SceneType *int64 `json:"SceneType,omitempty" name:"SceneType"`

	// Visual node configuration
	WebNodeTypeInfo *WebNodeTypeInfo `json:"WebNodeTypeInfo,omitempty" name:"WebNodeTypeInfo"`

	// Valid values: `https`, `http` (default)
	Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
}

func NewCreateInstanceRequest 

func NewCreateInstanceRequest() (request *CreateInstanceRequest)

func (*CreateInstanceRequest) FromJsonString 

func (r *CreateInstanceRequest) 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 (*CreateInstanceRequest) ToJsonString 

func (r *CreateInstanceRequest) ToJsonString() string

type CreateInstanceResponse 

type CreateInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

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

		// Order ID
		// Note: This field may return `null`, indicating that no valid value was found.
		DealName *string `json:"DealName,omitempty" name:"DealName"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateInstanceResponse 

func NewCreateInstanceResponse() (response *CreateInstanceResponse)

func (*CreateInstanceResponse) FromJsonString 

func (r *CreateInstanceResponse) 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 (*CreateInstanceResponse) ToJsonString 

func (r *CreateInstanceResponse) ToJsonString() string

type DeleteInstanceRequest 

type DeleteInstanceRequest struct {
	*tchttp.BaseRequest

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

func NewDeleteInstanceRequest 

func NewDeleteInstanceRequest() (request *DeleteInstanceRequest)

func (*DeleteInstanceRequest) FromJsonString 

func (r *DeleteInstanceRequest) 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 (*DeleteInstanceRequest) ToJsonString 

func (r *DeleteInstanceRequest) ToJsonString() string

type DeleteInstanceResponse 

type DeleteInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteInstanceResponse 

func NewDeleteInstanceResponse() (response *DeleteInstanceResponse)

func (*DeleteInstanceResponse) FromJsonString 

func (r *DeleteInstanceResponse) 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 (*DeleteInstanceResponse) ToJsonString 

func (r *DeleteInstanceResponse) ToJsonString() string

type DescribeInstanceLogsRequest 

type DescribeInstanceLogsRequest struct {
	*tchttp.BaseRequest

	// Cluster instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Log type. Default value: 1
	// <li>1: primary log</li>
	// <li>2: search slow log</li>
	// <li>3: index slow log</li>
	// <li>4: GC log</li>
	LogType *uint64 `json:"LogType,omitempty" name:"LogType"`

	// Search keyword, which supports LUCENE syntax, such as `level:WARN`, `ip:1.1.1.1`, and `message:test-index`
	SearchKey *string `json:"SearchKey,omitempty" name:"SearchKey"`

	// Log start time in the format of YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// Log end time in the format of YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// Pagination start value. Default value: 0
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of entries per page. Default value: 100. Maximum value: 100
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Time sorting order. Default value: 0
	// <li>0: descending</li>
	// <li>1: ascending</li>
	OrderByType *uint64 `json:"OrderByType,omitempty" name:"OrderByType"`
}

func NewDescribeInstanceLogsRequest 

func NewDescribeInstanceLogsRequest() (request *DescribeInstanceLogsRequest)

func (*DescribeInstanceLogsRequest) FromJsonString 

func (r *DescribeInstanceLogsRequest) 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 (*DescribeInstanceLogsRequest) ToJsonString 

func (r *DescribeInstanceLogsRequest) ToJsonString() string

type DescribeInstanceLogsResponse 

type DescribeInstanceLogsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Number of returned logs
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// Log details list
		InstanceLogList []*InstanceLog `json:"InstanceLogList,omitempty" name:"InstanceLogList"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInstanceLogsResponse 

func NewDescribeInstanceLogsResponse() (response *DescribeInstanceLogsResponse)

func (*DescribeInstanceLogsResponse) FromJsonString 

func (r *DescribeInstanceLogsResponse) 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 (*DescribeInstanceLogsResponse) ToJsonString 

func (r *DescribeInstanceLogsResponse) ToJsonString() string

type DescribeInstanceOperationsRequest 

type DescribeInstanceOperationsRequest struct {
	*tchttp.BaseRequest

	// Cluster instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Start time, such as "2019-03-07 16:30:39"
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// End time, such as "2019-03-30 20:18:03"
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// Pagination start value
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of entries per page
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeInstanceOperationsRequest 

func NewDescribeInstanceOperationsRequest() (request *DescribeInstanceOperationsRequest)

func (*DescribeInstanceOperationsRequest) FromJsonString 

func (r *DescribeInstanceOperationsRequest) 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 (*DescribeInstanceOperationsRequest) ToJsonString 

func (r *DescribeInstanceOperationsRequest) ToJsonString() string

type DescribeInstanceOperationsResponse 

type DescribeInstanceOperationsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Total number of operation records
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// Operation history
		Operations []*Operation `json:"Operations,omitempty" name:"Operations"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInstanceOperationsResponse 

func NewDescribeInstanceOperationsResponse() (response *DescribeInstanceOperationsResponse)

func (*DescribeInstanceOperationsResponse) FromJsonString 

func (r *DescribeInstanceOperationsResponse) 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 (*DescribeInstanceOperationsResponse) ToJsonString 

func (r *DescribeInstanceOperationsResponse) ToJsonString() string

type DescribeInstancesRequest 

type DescribeInstancesRequest struct {
	*tchttp.BaseRequest

	// AZ of the cluster instance. If this is not passed in, all AZs are used by default
	Zone *string `json:"Zone,omitempty" name:"Zone"`

	// List of cluster instance IDs
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// List of cluster instance names
	InstanceNames []*string `json:"InstanceNames,omitempty" name:"InstanceNames"`

	// Pagination start value. Default value: 0
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of entries per page. Default value: 20
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Sort by field <li>1: instance ID </li><li>2: instance name </li><li>3: AZ </li><li>4: creation time </li>If `orderKey` is not passed in, sort by creation time in descending order
	OrderByKey *uint64 `json:"OrderByKey,omitempty" name:"OrderByKey"`

	// Sorting order <li>0: ascending </li><li>1: descending </li>If orderByKey is passed in but orderByType is not, ascending order is used by default
	OrderByType *uint64 `json:"OrderByType,omitempty" name:"OrderByType"`

	// Node tag information list
	TagList []*TagInfo `json:"TagList,omitempty" name:"TagList"`

	// VPC VIP list
	IpList []*string `json:"IpList,omitempty" name:"IpList"`

	// List of availability zones
	ZoneList []*string `json:"ZoneList,omitempty" name:"ZoneList"`

	// Health status filter list
	HealthStatus []*int64 `json:"HealthStatus,omitempty" name:"HealthStatus"`
}

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 DescribeInstancesResponse 

type DescribeInstancesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Number of returned instances
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// List of instance details
		InstanceList []*InstanceInfo `json:"InstanceList,omitempty" name:"InstanceList"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeViewsRequest 

type DescribeViewsRequest struct {
	*tchttp.BaseRequest

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

func NewDescribeViewsRequest 

func NewDescribeViewsRequest() (request *DescribeViewsRequest)

func (*DescribeViewsRequest) FromJsonString 

func (r *DescribeViewsRequest) 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 (*DescribeViewsRequest) ToJsonString 

func (r *DescribeViewsRequest) ToJsonString() string

type DescribeViewsResponse 

type DescribeViewsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Cluster view
		// Note: This field may return `null`, indicating that no valid value was found.
		ClusterView *ClusterView `json:"ClusterView,omitempty" name:"ClusterView"`

		// Node view
		// Note: This field may return `null`, indicating that no valid value was found.
		NodesView []*NodeView `json:"NodesView,omitempty" name:"NodesView"`

		// Kibana view
		// Note: This field may return `null`, indicating that no valid value was found.
		KibanasView []*KibanaView `json:"KibanasView,omitempty" name:"KibanasView"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeViewsResponse 

func NewDescribeViewsResponse() (response *DescribeViewsResponse)

func (*DescribeViewsResponse) FromJsonString 

func (r *DescribeViewsResponse) 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 (*DescribeViewsResponse) ToJsonString 

func (r *DescribeViewsResponse) ToJsonString() string

type DictInfo 

type DictInfo struct {

	// Dictionary key value
	Key *string `json:"Key,omitempty" name:"Key"`

	// Dictionary name
	Name *string `json:"Name,omitempty" name:"Name"`

	// Dictionary size in B
	Size *uint64 `json:"Size,omitempty" name:"Size"`
}

type EsAcl 

type EsAcl struct {

	// Kibana access blocklist
	BlackIpList []*string `json:"BlackIpList,omitempty" name:"BlackIpList"`

	// Kibana access allowlist
	WhiteIpList []*string `json:"WhiteIpList,omitempty" name:"WhiteIpList"`
}

type EsDictionaryInfo 

type EsDictionaryInfo struct {

	// List of non-stop words
	MainDict []*DictInfo `json:"MainDict,omitempty" name:"MainDict"`

	// List of stop words
	Stopwords []*DictInfo `json:"Stopwords,omitempty" name:"Stopwords"`

	// QQ dictionary list
	QQDict []*DictInfo `json:"QQDict,omitempty" name:"QQDict"`

	// Synonym dictionary list
	Synonym []*DictInfo `json:"Synonym,omitempty" name:"Synonym"`

	// Update dictionary type
	UpdateType *string `json:"UpdateType,omitempty" name:"UpdateType"`
}

type EsPublicAcl 

type EsPublicAcl struct {

	// Access blocklist
	BlackIpList []*string `json:"BlackIpList,omitempty" name:"BlackIpList"`

	// Access allowlist
	WhiteIpList []*string `json:"WhiteIpList,omitempty" name:"WhiteIpList"`
}

type GetRequestTargetNodeTypesRequest 

type GetRequestTargetNodeTypesRequest struct {
	*tchttp.BaseRequest

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

func NewGetRequestTargetNodeTypesRequest 

func NewGetRequestTargetNodeTypesRequest() (request *GetRequestTargetNodeTypesRequest)

func (*GetRequestTargetNodeTypesRequest) FromJsonString 

func (r *GetRequestTargetNodeTypesRequest) 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 (*GetRequestTargetNodeTypesRequest) ToJsonString 

func (r *GetRequestTargetNodeTypesRequest) ToJsonString() string

type GetRequestTargetNodeTypesResponse 

type GetRequestTargetNodeTypesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// A list of node types used to receive requests.
		TargetNodeTypes []*string `json:"TargetNodeTypes,omitempty" name:"TargetNodeTypes"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewGetRequestTargetNodeTypesResponse 

func NewGetRequestTargetNodeTypesResponse() (response *GetRequestTargetNodeTypesResponse)

func (*GetRequestTargetNodeTypesResponse) FromJsonString 

func (r *GetRequestTargetNodeTypesResponse) 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 (*GetRequestTargetNodeTypesResponse) ToJsonString 

func (r *GetRequestTargetNodeTypesResponse) ToJsonString() string

type InstanceInfo 

type InstanceInfo struct {

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

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

	// Region
	Region *string `json:"Region,omitempty" name:"Region"`

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

	// User ID
	AppId *uint64 `json:"AppId,omitempty" name:"AppId"`

	// User UIN
	Uin *string `json:"Uin,omitempty" name:"Uin"`

	// UID of the VPC where the instance resides
	VpcUid *string `json:"VpcUid,omitempty" name:"VpcUid"`

	// UID of the subnet where the instance resides
	SubnetUid *string `json:"SubnetUid,omitempty" name:"SubnetUid"`

	// Instance status. 0: processing; 1: normal; -1: stopped; -2: terminating; -3: terminated
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// Instance billing method. Valid values: POSTPAID_BY_HOUR (pay-as-you-go hourly); CDHPAID (billed based on CDH, i.e., only CDH is billed but not the instances on CDH)
	ChargeType *string `json:"ChargeType,omitempty" name:"ChargeType"`

	// This parameter is not used on the global website
	ChargePeriod *uint64 `json:"ChargePeriod,omitempty" name:"ChargePeriod"`

	// This parameter is not used on the global website
	RenewFlag *string `json:"RenewFlag,omitempty" name:"RenewFlag"`

	// Node specification <li>ES.S1.SMALL2: 1-core 2 GB </li><li>ES.S1.MEDIUM4: 2-core 4 GB </li><li>ES.S1.MEDIUM8: 2-core 8 GB </li><li>ES.S1.LARGE16: 4-core 16 GB </li><li>ES.S1.2XLARGE32: 8-core 32 GB </li><li>ES.S1.4XLARGE32: 16-core 32 GB </li><li>ES.S1.4XLARGE64: 16-core 64 GB </li>
	NodeType *string `json:"NodeType,omitempty" name:"NodeType"`

	// Number of nodes
	NodeNum *uint64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Number of CPU cores of the node
	CpuNum *uint64 `json:"CpuNum,omitempty" name:"CpuNum"`

	// Node memory size in GB
	MemSize *uint64 `json:"MemSize,omitempty" name:"MemSize"`

	// Node disk type
	DiskType *string `json:"DiskType,omitempty" name:"DiskType"`

	// Node disk size in GB
	DiskSize *uint64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// ES domain name
	EsDomain *string `json:"EsDomain,omitempty" name:"EsDomain"`

	// ES VIP
	EsVip *string `json:"EsVip,omitempty" name:"EsVip"`

	// ES port
	EsPort *uint64 `json:"EsPort,omitempty" name:"EsPort"`

	// Kibana access URL
	KibanaUrl *string `json:"KibanaUrl,omitempty" name:"KibanaUrl"`

	// ES version number
	EsVersion *string `json:"EsVersion,omitempty" name:"EsVersion"`

	// ES configuration item
	EsConfig *string `json:"EsConfig,omitempty" name:"EsConfig"`

	// Kibana access control configuration
	EsAcl *EsAcl `json:"EsAcl,omitempty" name:"EsAcl"`

	// Instance creation time
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// Last modified time of the instance
	UpdateTime *string `json:"UpdateTime,omitempty" name:"UpdateTime"`

	// This parameter is not used on the global website
	Deadline *string `json:"Deadline,omitempty" name:"Deadline"`

	// Instance type (instance type identifier, which can be only 1 or 2 currently)
	InstanceType *uint64 `json:"InstanceType,omitempty" name:"InstanceType"`

	// IK analyzer configuration
	IkConfig *EsDictionaryInfo `json:"IkConfig,omitempty" name:"IkConfig"`

	// Dedicated primary node configuration
	MasterNodeInfo *MasterNodeInfo `json:"MasterNodeInfo,omitempty" name:"MasterNodeInfo"`

	// Auto-backup to COS configuration
	CosBackup *CosBackup `json:"CosBackup,omitempty" name:"CosBackup"`

	// Whether to allow auto-backup to COS
	AllowCosBackup *bool `json:"AllowCosBackup,omitempty" name:"AllowCosBackup"`

	// List of tags owned by the instance
	TagList []*TagInfo `json:"TagList,omitempty" name:"TagList"`

	// License type <li>oss: Open Source Edition </li><li>basic: Basic Edition </li><li>platinum: Platinum Edition </li>Default value: Platinum
	LicenseType *string `json:"LicenseType,omitempty" name:"LicenseType"`

	// Whether it is a hot/warm cluster <li>true: yes </li><li>false: no</li>
	// Note: this field may return null, indicating that no valid values can be obtained.
	EnableHotWarmMode *bool `json:"EnableHotWarmMode,omitempty" name:"EnableHotWarmMode"`

	// Warm node specification <li>ES.S1.SMALL2: 1-core 2 GB </li><li>ES.S1.MEDIUM4: 2-core 4 GB </li><li>ES.S1.MEDIUM8: 2-core 8 GB </li><li>ES.S1.LARGE16: 4-core 16 GB </li><li>ES.S1.2XLARGE32: 8-core 32 GB </li><li>ES.S1.4XLARGE32: 16-core 32 GB </li><li>ES.S1.4XLARGE64: 16-core 64 GB </li>
	// Note: This field may return `null`, indicating that no valid value was found.
	WarmNodeType *string `json:"WarmNodeType,omitempty" name:"WarmNodeType"`

	// Number of warm nodes
	// Note: This field may return `null`, indicating that no valid value was found.
	WarmNodeNum *uint64 `json:"WarmNodeNum,omitempty" name:"WarmNodeNum"`

	// Number of warm node CPU cores
	// Note: This field may return `null`, indicating that no valid value was found.
	WarmCpuNum *uint64 `json:"WarmCpuNum,omitempty" name:"WarmCpuNum"`

	// Warm node memory size (in GB)
	// Note: This field may return `null`, indicating that no valid value was found.
	WarmMemSize *uint64 `json:"WarmMemSize,omitempty" name:"WarmMemSize"`

	// Warm node disk type
	// Note: This field may return `null`, indicating that no valid value was found.
	WarmDiskType *string `json:"WarmDiskType,omitempty" name:"WarmDiskType"`

	// Warm node disk size (in GB)
	// Note: This field may return `null`, indicating that no valid value was found.
	WarmDiskSize *uint64 `json:"WarmDiskSize,omitempty" name:"WarmDiskSize"`

	// Cluster node information list
	// Note: This field may return null, indicating that no valid values can be obtained.
	NodeInfoList []*NodeInfo `json:"NodeInfoList,omitempty" name:"NodeInfoList"`

	// ES public IP address
	// Note: This field may return null, indicating that no valid values can be obtained.
	EsPublicUrl *string `json:"EsPublicUrl,omitempty" name:"EsPublicUrl"`

	// Multi-AZ network information
	// Note: This field may return null, indicating that no valid values can be obtained.
	MultiZoneInfo []*ZoneDetail `json:"MultiZoneInfo,omitempty" name:"MultiZoneInfo"`

	// Deployment mode <li>0: single-AZ </li><li>1: multi-AZ</li>
	// Note: This field may return null, indicating that no valid values can be obtained.
	DeployMode *uint64 `json:"DeployMode,omitempty" name:"DeployMode"`

	// ES public access status <li>OPEN: enabled </li><li>CLOSE: disabled
	// Note: This field may return null, indicating that no valid values can be obtained.
	PublicAccess *string `json:"PublicAccess,omitempty" name:"PublicAccess"`

	// ES public access control configuration
	EsPublicAcl *EsAcl `json:"EsPublicAcl,omitempty" name:"EsPublicAcl"`

	// Kibana private IP address
	// Note: This field may return null, indicating that no valid values can be obtained.
	KibanaPrivateUrl *string `json:"KibanaPrivateUrl,omitempty" name:"KibanaPrivateUrl"`

	// Kibana public access status <li>OPEN: enabled </li><li>CLOSE: disabled
	// Note: This field may return null, indicating that no valid values can be obtained.
	KibanaPublicAccess *string `json:"KibanaPublicAccess,omitempty" name:"KibanaPublicAccess"`

	// Kibana private access status <li>OPEN: enabled </li><li>CLOSE: disabled
	// Note: This field may return null, indicating that no valid values can be obtained.
	KibanaPrivateAccess *string `json:"KibanaPrivateAccess,omitempty" name:"KibanaPrivateAccess"`

	// Whether to enable X-Pack security authentication in Basic Edition 6.8 (and above) <li>1: disabled </li><li>2: enabled</li>
	// Note: This field may return null, indicating that no valid values can be obtained.
	SecurityType *uint64 `json:"SecurityType,omitempty" name:"SecurityType"`

	// Scenario template type. 0: not enabled; 1: general scenario; 2: log scenario; 3: search scenario
	// Note: this field may return null, indicating that no valid values can be obtained.
	SceneType *int64 `json:"SceneType,omitempty" name:"SceneType"`

	// Kibana configuration item.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	KibanaConfig *string `json:"KibanaConfig,omitempty" name:"KibanaConfig"`

	// Kibana node information
	// Note: this field may return `null`, indicating that no valid value can be obtained.
	KibanaNodeInfo *KibanaNodeInfo `json:"KibanaNodeInfo,omitempty" name:"KibanaNodeInfo"`

	// Visual node configuration
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	WebNodeTypeInfo *WebNodeTypeInfo `json:"WebNodeTypeInfo,omitempty" name:"WebNodeTypeInfo"`

	// JDK type. Valid values: `oracle`, `kona`
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Jdk *string `json:"Jdk,omitempty" name:"Jdk"`

	// Cluster network communication protocol
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Protocol *string `json:"Protocol,omitempty" name:"Protocol"`

	// Security group ID
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	SecurityGroups []*string `json:"SecurityGroups,omitempty" name:"SecurityGroups"`

	// Cold node specification <li>ES.S1.SMALL2: 1-core 2 GB </li><li>ES.S1.MEDIUM4: 2-core 4 GB </li><li>ES.S1.MEDIUM8: 2-core 8 GB </li><li>ES.S1.LARGE16: 4-core 16 GB </li><li>ES.S1.2XLARGE32: 8-core 32 GB </li><li>ES.S1.4XLARGE32: 16-core 32 GB </li><li>ES.S1.4XLARGE64: 16-core 64 GB </li>
	// Note: This field may return `null`, indicating that no valid value was found.
	ColdNodeType *string `json:"ColdNodeType,omitempty" name:"ColdNodeType"`

	// Number of cold nodes
	// Note: This field may return `null`, indicating that no valid value was found.
	ColdNodeNum *uint64 `json:"ColdNodeNum,omitempty" name:"ColdNodeNum"`

	// Number of cold node CPU cores
	// Note: This field may return `null`, indicating that no valid value was found.
	ColdCpuNum *uint64 `json:"ColdCpuNum,omitempty" name:"ColdCpuNum"`

	// Cold node memory size (in GB)
	// Note: This field may return `null`, indicating that no valid value was found.
	ColdMemSize *uint64 `json:"ColdMemSize,omitempty" name:"ColdMemSize"`

	// Cold node disk type
	// Note: This field may return `null`, indicating that no valid value was found.
	ColdDiskType *string `json:"ColdDiskType,omitempty" name:"ColdDiskType"`

	// Cold node disk size (in GB)
	// Note: This field may return `null`, indicating that no valid value was found.
	ColdDiskSize *uint64 `json:"ColdDiskSize,omitempty" name:"ColdDiskSize"`

	// Frozen node specification <li>ES.S1.SMALL2: 1-core 2 GB </li><li>ES.S1.MEDIUM4: 2-core 4 GB </li><li>ES.S1.MEDIUM8: 2-core 8 GB </li><li>ES.S1.LARGE16: 4-core 16 GB </li><li>ES.S1.2XLARGE32: 8-core 32 GB </li><li>ES.S1.4XLARGE32: 16-core 32 GB </li><li>ES.S1.4XLARGE64: 16-core 64 GB </li>
	// Note: This field may return `null`, indicating that no valid value was found.
	FrozenNodeType *string `json:"FrozenNodeType,omitempty" name:"FrozenNodeType"`

	// Number of frozen nodes
	// Note: This field may return `null`, indicating that no valid value was found.
	FrozenNodeNum *uint64 `json:"FrozenNodeNum,omitempty" name:"FrozenNodeNum"`

	// Number of frozen node CPU cores
	// Note: This field may return `null`, indicating that no valid value was found.
	FrozenCpuNum *uint64 `json:"FrozenCpuNum,omitempty" name:"FrozenCpuNum"`

	// Frozen node memory size (GB)
	// Note: This field may return `null`, indicating that no valid value was found.
	FrozenMemSize *uint64 `json:"FrozenMemSize,omitempty" name:"FrozenMemSize"`

	// Frozen node disk type
	// Note: This field may return `null`, indicating that no valid value was found.
	FrozenDiskType *string `json:"FrozenDiskType,omitempty" name:"FrozenDiskType"`

	// Frozen node disk size (in GB)
	// Note: This field may return `null`, indicating that no valid value was found.
	FrozenDiskSize *uint64 `json:"FrozenDiskSize,omitempty" name:"FrozenDiskSize"`

	// Cluster health status. `-1`: Unknown; `0`: Green; `1`: Yellow; `2`: Red
	// Note: This field may return `null`, indicating that no valid value was found.
	HealthStatus *int64 `json:"HealthStatus,omitempty" name:"HealthStatus"`

	// Private URL of the HTTPS cluster
	// Note: This field may return `null`, indicating that no valid value was found.
	EsPrivateUrl *string `json:"EsPrivateUrl,omitempty" name:"EsPrivateUrl"`

	// Private domain of the HTTPS cluster
	// Note: This field may return `null`, indicating that no valid value was found.
	EsPrivateDomain *string `json:"EsPrivateDomain,omitempty" name:"EsPrivateDomain"`
}

type InstanceLog 

type InstanceLog struct {

	// Log time
	Time *string `json:"Time,omitempty" name:"Time"`

	// Log level
	Level *string `json:"Level,omitempty" name:"Level"`

	// Cluster node IP
	Ip *string `json:"Ip,omitempty" name:"Ip"`

	// Log content
	Message *string `json:"Message,omitempty" name:"Message"`
}

type KeyValue 

type KeyValue struct {

	// Key
	Key *string `json:"Key,omitempty" name:"Key"`

	// Value
	Value *string `json:"Value,omitempty" name:"Value"`
}

type KibanaNodeInfo 

type KibanaNodeInfo struct {

	// Kibana node specification
	KibanaNodeType *string `json:"KibanaNodeType,omitempty" name:"KibanaNodeType"`

	// Number of Kibana nodes
	KibanaNodeNum *uint64 `json:"KibanaNodeNum,omitempty" name:"KibanaNodeNum"`

	// Number of Kibana node's CPUs
	KibanaNodeCpuNum *uint64 `json:"KibanaNodeCpuNum,omitempty" name:"KibanaNodeCpuNum"`

	// Kibana node's memory in GB
	KibanaNodeMemSize *uint64 `json:"KibanaNodeMemSize,omitempty" name:"KibanaNodeMemSize"`

	// Kibana node's disk type
	KibanaNodeDiskType *string `json:"KibanaNodeDiskType,omitempty" name:"KibanaNodeDiskType"`

	// Kibana node's disk size
	KibanaNodeDiskSize *uint64 `json:"KibanaNodeDiskSize,omitempty" name:"KibanaNodeDiskSize"`
}

type KibanaView 

type KibanaView struct {

	// Kibana node IP
	Ip *string `json:"Ip,omitempty" name:"Ip"`

	// Node disk size
	DiskSize *int64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// Disk usage
	DiskUsage *float64 `json:"DiskUsage,omitempty" name:"DiskUsage"`

	// Node memory size
	MemSize *int64 `json:"MemSize,omitempty" name:"MemSize"`

	// Memory usage
	MemUsage *float64 `json:"MemUsage,omitempty" name:"MemUsage"`

	// Number of node CPUs
	CpuNum *int64 `json:"CpuNum,omitempty" name:"CpuNum"`

	// CPU usage
	CpuUsage *float64 `json:"CpuUsage,omitempty" name:"CpuUsage"`

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

type LocalDiskInfo 

type LocalDiskInfo struct {

	// Local disk type <li>LOCAL_SATA: big data </li><li>NVME_SSD: high IO</li>
	LocalDiskType *string `json:"LocalDiskType,omitempty" name:"LocalDiskType"`

	// Size of a single local disk
	LocalDiskSize *uint64 `json:"LocalDiskSize,omitempty" name:"LocalDiskSize"`

	// Number of local disks
	LocalDiskCount *uint64 `json:"LocalDiskCount,omitempty" name:"LocalDiskCount"`
}

type MasterNodeInfo 

type MasterNodeInfo struct {

	// Whether to enable the dedicated primary node
	EnableDedicatedMaster *bool `json:"EnableDedicatedMaster,omitempty" name:"EnableDedicatedMaster"`

	// Dedicated primary node specification <li>ES.S1.SMALL2: 1-core 2 GB</li><li>ES.S1.MEDIUM4: 2-core 4 GB</li><li>ES.S1.MEDIUM8: 2-core 8 GB</li><li>ES.S1.LARGE16: 4-core 16 GB</li><li>ES.S1.2XLARGE32: 8-core 32 GB</li><li>ES.S1.4XLARGE32: 16-core 32 GB</li><li>ES.S1.4XLARGE64: 16-core 64 GB</li>
	MasterNodeType *string `json:"MasterNodeType,omitempty" name:"MasterNodeType"`

	// Number of dedicated primary nodes
	MasterNodeNum *uint64 `json:"MasterNodeNum,omitempty" name:"MasterNodeNum"`

	// Number of CPU cores of the dedicated primary node
	MasterNodeCpuNum *uint64 `json:"MasterNodeCpuNum,omitempty" name:"MasterNodeCpuNum"`

	// Memory size of the dedicated primary node in GB
	MasterNodeMemSize *uint64 `json:"MasterNodeMemSize,omitempty" name:"MasterNodeMemSize"`

	// Disk size of the dedicated primary node in GB
	MasterNodeDiskSize *uint64 `json:"MasterNodeDiskSize,omitempty" name:"MasterNodeDiskSize"`

	// Disk type of the dedicated primary node
	MasterNodeDiskType *string `json:"MasterNodeDiskType,omitempty" name:"MasterNodeDiskType"`
}

type NodeInfo 

type NodeInfo struct {

	// Number of nodes
	NodeNum *uint64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Node specification <li>ES.S1.SMALL2: 1-core 2 GB </li><li>ES.S1.MEDIUM4: 2-core 4 GB </li><li>ES.S1.MEDIUM8: 2-core 8 GB </li><li>ES.S1.LARGE16: 4-core 16 GB </li><li>ES.S1.2XLARGE32: 8-core 32 GB </li><li>ES.S1.4XLARGE32: 16-core 32 GB </li><li>ES.S1.4XLARGE64: 16-core 64 GB </li>
	NodeType *string `json:"NodeType,omitempty" name:"NodeType"`

	// Node type<li>`hotData`: hot data node</li>
	// <li>`warmData`: warm data node</li>
	// <li>`dedicatedMaster`: dedicated master node</li>
	// Default value: `hotData`
	Type *string `json:"Type,omitempty" name:"Type"`

	// Node disk type <li>CLOUD_SSD: SSD cloud storage </li><li>CLOUD_PREMIUM: Premium cloud disk </li>Default value: CLOUD_SSD
	DiskType *string `json:"DiskType,omitempty" name:"DiskType"`

	// Node disk size in GB
	DiskSize *uint64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// Local disk information
	// Note: this field may return null, indicating that no valid values can be obtained.
	LocalDiskInfo *LocalDiskInfo `json:"LocalDiskInfo,omitempty" name:"LocalDiskInfo"`

	// Number of node disks
	DiskCount *uint64 `json:"DiskCount,omitempty" name:"DiskCount"`

	// Whether to encrypt node disk. 0: no (default); 1: yes.
	DiskEncrypt *uint64 `json:"DiskEncrypt,omitempty" name:"DiskEncrypt"`
}

type NodeView 

type NodeView struct {

	// Node ID
	NodeId *string `json:"NodeId,omitempty" name:"NodeId"`

	// Node IP
	NodeIp *string `json:"NodeIp,omitempty" name:"NodeIp"`

	// Whether the node is visible
	Visible *float64 `json:"Visible,omitempty" name:"Visible"`

	// Whether the node encounters circuit breaking
	Break *float64 `json:"Break,omitempty" name:"Break"`

	// Node disk size
	DiskSize *int64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// Disk usage
	DiskUsage *float64 `json:"DiskUsage,omitempty" name:"DiskUsage"`

	// Node memory size (in GB)
	MemSize *int64 `json:"MemSize,omitempty" name:"MemSize"`

	// Memory usage
	MemUsage *float64 `json:"MemUsage,omitempty" name:"MemUsage"`

	// Number of node CPUs
	CpuNum *int64 `json:"CpuNum,omitempty" name:"CpuNum"`

	// CPU usage
	CpuUsage *float64 `json:"CpuUsage,omitempty" name:"CpuUsage"`

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

	// Node role
	NodeRole *string `json:"NodeRole,omitempty" name:"NodeRole"`

	// Node HTTP IP
	NodeHttpIp *string `json:"NodeHttpIp,omitempty" name:"NodeHttpIp"`

	// JVM memory usage
	JvmMemUsage *float64 `json:"JvmMemUsage,omitempty" name:"JvmMemUsage"`

	// Number of node shards
	ShardNum *int64 `json:"ShardNum,omitempty" name:"ShardNum"`

	// ID list of node disks
	DiskIds []*string `json:"DiskIds,omitempty" name:"DiskIds"`

	// Whether a hidden availability zone
	Hidden *bool `json:"Hidden,omitempty" name:"Hidden"`
}

type Operation 

type Operation struct {

	// Unique operation ID
	Id *uint64 `json:"Id,omitempty" name:"Id"`

	// Operation start time
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// Operation type
	Type *string `json:"Type,omitempty" name:"Type"`

	// Operation details
	Detail *OperationDetail `json:"Detail,omitempty" name:"Detail"`

	// Operation result
	Result *string `json:"Result,omitempty" name:"Result"`

	// Workflow task information
	Tasks []*TaskDetail `json:"Tasks,omitempty" name:"Tasks"`

	// Operation progress
	Progress *float64 `json:"Progress,omitempty" name:"Progress"`
}

type OperationDetail 

type OperationDetail struct {

	// Original instance configuration information
	OldInfo []*KeyValue `json:"OldInfo,omitempty" name:"OldInfo"`

	// Updated instance configuration information
	NewInfo []*KeyValue `json:"NewInfo,omitempty" name:"NewInfo"`
}

type RestartInstanceRequest 

type RestartInstanceRequest struct {
	*tchttp.BaseRequest

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

	// Whether to force restart <li>true: Yes </li><li>false: No </li>Default value: false
	ForceRestart *bool `json:"ForceRestart,omitempty" name:"ForceRestart"`

	// Restart mode. `0`: rolling restart; `1`: full restart
	RestartMode *int64 `json:"RestartMode,omitempty" name:"RestartMode"`
}

func NewRestartInstanceRequest 

func NewRestartInstanceRequest() (request *RestartInstanceRequest)

func (*RestartInstanceRequest) FromJsonString 

func (r *RestartInstanceRequest) 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 (*RestartInstanceRequest) ToJsonString 

func (r *RestartInstanceRequest) ToJsonString() string

type RestartInstanceResponse 

type RestartInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewRestartInstanceResponse 

func NewRestartInstanceResponse() (response *RestartInstanceResponse)

func (*RestartInstanceResponse) FromJsonString 

func (r *RestartInstanceResponse) 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 (*RestartInstanceResponse) ToJsonString 

func (r *RestartInstanceResponse) ToJsonString() string

type RestartKibanaRequest 

type RestartKibanaRequest struct {
	*tchttp.BaseRequest

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

func NewRestartKibanaRequest 

func NewRestartKibanaRequest() (request *RestartKibanaRequest)

func (*RestartKibanaRequest) FromJsonString 

func (r *RestartKibanaRequest) 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 (*RestartKibanaRequest) ToJsonString 

func (r *RestartKibanaRequest) ToJsonString() string

type RestartKibanaResponse 

type RestartKibanaResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewRestartKibanaResponse 

func NewRestartKibanaResponse() (response *RestartKibanaResponse)

func (*RestartKibanaResponse) FromJsonString 

func (r *RestartKibanaResponse) 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 (*RestartKibanaResponse) ToJsonString 

func (r *RestartKibanaResponse) ToJsonString() string

type RestartNodesRequest 

type RestartNodesRequest struct {
	*tchttp.BaseRequest

	// Cluster instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Node name list
	NodeNames []*string `json:"NodeNames,omitempty" name:"NodeNames"`

	// Whether to force restart
	ForceRestart *bool `json:"ForceRestart,omitempty" name:"ForceRestart"`
}

func NewRestartNodesRequest 

func NewRestartNodesRequest() (request *RestartNodesRequest)

func (*RestartNodesRequest) FromJsonString 

func (r *RestartNodesRequest) 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 (*RestartNodesRequest) ToJsonString 

func (r *RestartNodesRequest) ToJsonString() string

type RestartNodesResponse 

type RestartNodesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewRestartNodesResponse 

func NewRestartNodesResponse() (response *RestartNodesResponse)

func (*RestartNodesResponse) FromJsonString 

func (r *RestartNodesResponse) 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 (*RestartNodesResponse) ToJsonString 

func (r *RestartNodesResponse) ToJsonString() string

type SubTaskDetail 

type SubTaskDetail struct {

	// Subtask name
	Name *string `json:"Name,omitempty" name:"Name"`

	// Subtask result
	Result *bool `json:"Result,omitempty" name:"Result"`

	// Subtask error message
	ErrMsg *string `json:"ErrMsg,omitempty" name:"ErrMsg"`

	// Subtask type
	Type *string `json:"Type,omitempty" name:"Type"`

	// Subtask status. 0: processing, 1: succeeded, -1: failed
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// Name of the index for which the check for upgrade failed
	FailedIndices []*string `json:"FailedIndices,omitempty" name:"FailedIndices"`

	// Subtask end time
	FinishTime *string `json:"FinishTime,omitempty" name:"FinishTime"`

	// Subtask level. 1: warning, 2: failed
	Level *int64 `json:"Level,omitempty" name:"Level"`
}

type TagInfo 

type TagInfo struct {

	// Tag key
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`

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

type TaskDetail 

type TaskDetail struct {

	// Task name
	Name *string `json:"Name,omitempty" name:"Name"`

	// Task progress
	Progress *float64 `json:"Progress,omitempty" name:"Progress"`

	// Task completion time
	FinishTime *string `json:"FinishTime,omitempty" name:"FinishTime"`

	// Subtask
	SubTasks []*SubTaskDetail `json:"SubTasks,omitempty" name:"SubTasks"`
}

type UpdateInstanceRequest 

type UpdateInstanceRequest struct {
	*tchttp.BaseRequest

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

	// Instance name, which can contain 1 to 50 English letters, Chinese characters, digits, dashes (-), or underscores (_)
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Number of nodes (2-50)
	NodeNum *uint64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// ES configuration item (JSON string)
	EsConfig *string `json:"EsConfig,omitempty" name:"EsConfig"`

	// Password of the default user 'elastic', which must contain 8 to 16 characters, including at least two of the following three types of characters: [a-z,A-Z], [0-9] and [-!@#$%&^*+=_:;,.?]
	Password *string `json:"Password,omitempty" name:"Password"`

	// Access control list
	EsAcl *EsAcl `json:"EsAcl,omitempty" name:"EsAcl"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Disk size in GB
	DiskSize *uint64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Node specification <li>ES.S1.SMALL2: 1-core 2 GB </li><li>ES.S1.MEDIUM4: 2-core 4 GB </li><li>ES.S1.MEDIUM8: 2-core 8 GB </li><li>ES.S1.LARGE16: 4-core 16 GB </li><li>ES.S1.2XLARGE32: 8-core 32 GB </li><li>ES.S1.4XLARGE32: 16-core 32 GB </li><li>ES.S1.4XLARGE64: 16-core 64 GB </li>
	NodeType *string `json:"NodeType,omitempty" name:"NodeType"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Number of dedicated primary nodes (only 3 and 5 are supported)
	MasterNodeNum *uint64 `json:"MasterNodeNum,omitempty" name:"MasterNodeNum"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Dedicated primary node specification <li>ES.S1.SMALL2: 1-core 2 GB</li><li>ES.S1.MEDIUM4: 2-core 4 GB</li><li>ES.S1.MEDIUM8: 2-core 8 GB</li><li>ES.S1.LARGE16: 4-core 16 GB</li><li>ES.S1.2XLARGE32: 8-core 32 GB</li><li>ES.S1.4XLARGE32: 16-core 32 GB</li><li>ES.S1.4XLARGE64: 16-core 64 GB</li>
	MasterNodeType *string `json:"MasterNodeType,omitempty" name:"MasterNodeType"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Dedicated primary node disk size in GB. This is 50 GB by default and currently cannot be customized
	MasterNodeDiskSize *uint64 `json:"MasterNodeDiskSize,omitempty" name:"MasterNodeDiskSize"`

	// Whether to force restart during configuration update <li>true: Yes </li><li>false: No </li>This needs to be set only for EsConfig. Default value: false
	ForceRestart *bool `json:"ForceRestart,omitempty" name:"ForceRestart"`

	// Auto-backup to COS
	CosBackup *CosBackup `json:"CosBackup,omitempty" name:"CosBackup"`

	// Node information list. You can pass in only the nodes to be updated and their corresponding specification information. Supported operations include: <li>modifying the number of nodes in the same type </li><li>modifying the specification and disk size of nodes in the same type </li><li>adding a node type (you must also specify the node type, quantity, specification, disk, etc.) </li>The above operations can only be performed one at a time, and the disk type cannot be modified
	NodeInfoList []*NodeInfo `json:"NodeInfoList,omitempty" name:"NodeInfoList"`

	// Public network access status
	PublicAccess *string `json:"PublicAccess,omitempty" name:"PublicAccess"`

	// Public network ACL
	EsPublicAcl *EsPublicAcl `json:"EsPublicAcl,omitempty" name:"EsPublicAcl"`

	// Public network access status of Kibana
	KibanaPublicAccess *string `json:"KibanaPublicAccess,omitempty" name:"KibanaPublicAccess"`

	// Private network access status of Kibana
	KibanaPrivateAccess *string `json:"KibanaPrivateAccess,omitempty" name:"KibanaPrivateAccess"`

	// Enables or disables user authentication for ES Basic Edition v6.8 and above
	BasicSecurityType *int64 `json:"BasicSecurityType,omitempty" name:"BasicSecurityType"`

	// Kibana private port
	KibanaPrivatePort *uint64 `json:"KibanaPrivatePort,omitempty" name:"KibanaPrivatePort"`

	// 0: scaling in blue/green deployment mode without cluster restart (default); 1: scaling by unmounting disk with rolling cluster restart
	ScaleType *int64 `json:"ScaleType,omitempty" name:"ScaleType"`

	// Multi-AZ deployment
	MultiZoneInfo []*ZoneDetail `json:"MultiZoneInfo,omitempty" name:"MultiZoneInfo"`

	// Scenario template type. -1: not enabled; 1: general; 2: log; 3: search
	SceneType *int64 `json:"SceneType,omitempty" name:"SceneType"`

	// Kibana configuration item (JSON string)
	KibanaConfig *string `json:"KibanaConfig,omitempty" name:"KibanaConfig"`

	// Visual node configuration
	WebNodeTypeInfo *WebNodeTypeInfo `json:"WebNodeTypeInfo,omitempty" name:"WebNodeTypeInfo"`

	// Whether to switch to the new network architecture
	SwitchPrivateLink *string `json:"SwitchPrivateLink,omitempty" name:"SwitchPrivateLink"`

	// Whether to enable Cerebro
	EnableCerebro *bool `json:"EnableCerebro,omitempty" name:"EnableCerebro"`

	// Cerebro public network access status
	CerebroPublicAccess *string `json:"CerebroPublicAccess,omitempty" name:"CerebroPublicAccess"`

	// Cerebro private network access status
	CerebroPrivateAccess *string `json:"CerebroPrivateAccess,omitempty" name:"CerebroPrivateAccess"`
}

func NewUpdateInstanceRequest 

func NewUpdateInstanceRequest() (request *UpdateInstanceRequest)

func (*UpdateInstanceRequest) FromJsonString 

func (r *UpdateInstanceRequest) 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 (*UpdateInstanceRequest) ToJsonString 

func (r *UpdateInstanceRequest) ToJsonString() string

type UpdateInstanceResponse 

type UpdateInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Order ID
		// Note: This field may return `null`, indicating that no valid value was found.
		DealName *string `json:"DealName,omitempty" name:"DealName"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewUpdateInstanceResponse 

func NewUpdateInstanceResponse() (response *UpdateInstanceResponse)

func (*UpdateInstanceResponse) FromJsonString 

func (r *UpdateInstanceResponse) 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 (*UpdateInstanceResponse) ToJsonString 

func (r *UpdateInstanceResponse) ToJsonString() string

type UpdatePluginsRequest 

type UpdatePluginsRequest struct {
	*tchttp.BaseRequest

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

	// List of names of the plugins to be installed
	InstallPluginList []*string `json:"InstallPluginList,omitempty" name:"InstallPluginList"`

	// List of names of the plugins to be uninstalled
	RemovePluginList []*string `json:"RemovePluginList,omitempty" name:"RemovePluginList"`

	// Whether to force restart
	ForceRestart *bool `json:"ForceRestart,omitempty" name:"ForceRestart"`

	// Whether to reinstall
	ForceUpdate *bool `json:"ForceUpdate,omitempty" name:"ForceUpdate"`

	// 0: system plugin
	PluginType *uint64 `json:"PluginType,omitempty" name:"PluginType"`
}

func NewUpdatePluginsRequest 

func NewUpdatePluginsRequest() (request *UpdatePluginsRequest)

func (*UpdatePluginsRequest) FromJsonString 

func (r *UpdatePluginsRequest) 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 (*UpdatePluginsRequest) ToJsonString 

func (r *UpdatePluginsRequest) ToJsonString() string

type UpdatePluginsResponse 

type UpdatePluginsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewUpdatePluginsResponse 

func NewUpdatePluginsResponse() (response *UpdatePluginsResponse)

func (*UpdatePluginsResponse) FromJsonString 

func (r *UpdatePluginsResponse) 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 (*UpdatePluginsResponse) ToJsonString 

func (r *UpdatePluginsResponse) ToJsonString() string

type UpdateRequestTargetNodeTypesRequest 

type UpdateRequestTargetNodeTypesRequest struct {
	*tchttp.BaseRequest

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

	// A list of node types used to receive requests.
	TargetNodeTypes []*string `json:"TargetNodeTypes,omitempty" name:"TargetNodeTypes"`
}

func NewUpdateRequestTargetNodeTypesRequest 

func NewUpdateRequestTargetNodeTypesRequest() (request *UpdateRequestTargetNodeTypesRequest)

func (*UpdateRequestTargetNodeTypesRequest) FromJsonString 

func (r *UpdateRequestTargetNodeTypesRequest) 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 (*UpdateRequestTargetNodeTypesRequest) ToJsonString 

func (r *UpdateRequestTargetNodeTypesRequest) ToJsonString() string

type UpdateRequestTargetNodeTypesResponse 

type UpdateRequestTargetNodeTypesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewUpdateRequestTargetNodeTypesResponse 

func NewUpdateRequestTargetNodeTypesResponse() (response *UpdateRequestTargetNodeTypesResponse)

func (*UpdateRequestTargetNodeTypesResponse) FromJsonString 

func (r *UpdateRequestTargetNodeTypesResponse) 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 (*UpdateRequestTargetNodeTypesResponse) ToJsonString 

func (r *UpdateRequestTargetNodeTypesResponse) ToJsonString() string

type UpgradeInstanceRequest 

type UpgradeInstanceRequest struct {
	*tchttp.BaseRequest

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

	// Target ES version. Valid values: 6.4.3, 6.8.2, 7.5.1
	EsVersion *string `json:"EsVersion,omitempty" name:"EsVersion"`

	// Whether to check for upgrade only. Default value: false
	CheckOnly *bool `json:"CheckOnly,omitempty" name:"CheckOnly"`

	// Target X-Pack edition: <li>OSS: Open-source Edition </li><li>basic: Basic Edition </li>Currently only used for v5.6.4 to v6.x upgrade. Default value: basic
	LicenseType *string `json:"LicenseType,omitempty" name:"LicenseType"`

	// Whether to enable X-Pack security authentication in Basic Edition 6.8 (and above) <li>1: disabled </li><li>2: enabled</li>
	BasicSecurityType *uint64 `json:"BasicSecurityType,omitempty" name:"BasicSecurityType"`

	// Upgrade mode. <li>scale: blue/green deployment</li><li>restart: rolling restart</li>Default value: scale
	UpgradeMode *string `json:"UpgradeMode,omitempty" name:"UpgradeMode"`

	// Whether to back up the cluster before version upgrade (no backup by default)
	CosBackup *bool `json:"CosBackup,omitempty" name:"CosBackup"`
}

func NewUpgradeInstanceRequest 

func NewUpgradeInstanceRequest() (request *UpgradeInstanceRequest)

func (*UpgradeInstanceRequest) FromJsonString 

func (r *UpgradeInstanceRequest) 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 (*UpgradeInstanceRequest) ToJsonString 

func (r *UpgradeInstanceRequest) ToJsonString() string

type UpgradeInstanceResponse 

type UpgradeInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewUpgradeInstanceResponse 

func NewUpgradeInstanceResponse() (response *UpgradeInstanceResponse)

func (*UpgradeInstanceResponse) FromJsonString 

func (r *UpgradeInstanceResponse) 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 (*UpgradeInstanceResponse) ToJsonString 

func (r *UpgradeInstanceResponse) ToJsonString() string

type UpgradeLicenseRequest 

type UpgradeLicenseRequest struct {
	*tchttp.BaseRequest

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

	// License type <li>oss: Open Source Edition </li><li>basic: Basic Edition </li><li>platinum: Platinum Edition </li>Default value: Platinum
	LicenseType *string `json:"LicenseType,omitempty" name:"LicenseType"`

	// Whether to automatically use vouchers <li>0: No </li><li>1: Yes </li>Default value: 0
	AutoVoucher *int64 `json:"AutoVoucher,omitempty" name:"AutoVoucher"`

	// List of voucher IDs (only one voucher can be specified at a time currently)
	VoucherIds []*string `json:"VoucherIds,omitempty" name:"VoucherIds"`

	// Whether to enable X-Pack security authentication in Basic Edition 6.8 (and above) <li>1: disabled </li><li>2: enabled</li>
	BasicSecurityType *uint64 `json:"BasicSecurityType,omitempty" name:"BasicSecurityType"`

	// Whether to force restart <li>true: yes </li><li>false: no </li>Default value: false
	ForceRestart *bool `json:"ForceRestart,omitempty" name:"ForceRestart"`
}

func NewUpgradeLicenseRequest 

func NewUpgradeLicenseRequest() (request *UpgradeLicenseRequest)

func (*UpgradeLicenseRequest) FromJsonString 

func (r *UpgradeLicenseRequest) 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 (*UpgradeLicenseRequest) ToJsonString 

func (r *UpgradeLicenseRequest) ToJsonString() string

type UpgradeLicenseResponse 

type UpgradeLicenseResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Order ID
		// Note: This field may return `null`, indicating that no valid value was found.
		DealName *string `json:"DealName,omitempty" name:"DealName"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewUpgradeLicenseResponse 

func NewUpgradeLicenseResponse() (response *UpgradeLicenseResponse)

func (*UpgradeLicenseResponse) FromJsonString 

func (r *UpgradeLicenseResponse) 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 (*UpgradeLicenseResponse) ToJsonString 

func (r *UpgradeLicenseResponse) ToJsonString() string

type WebNodeTypeInfo 

type WebNodeTypeInfo struct {

	// Number of visual nodes. The value is always `1`.
	NodeNum *uint64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Visual node specification
	NodeType *string `json:"NodeType,omitempty" name:"NodeType"`
}

type ZoneDetail 

type ZoneDetail struct {

	// AZ
	Zone *string `json:"Zone,omitempty" name:"Zone"`

	// Subnet ID
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`
}

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.