v20180416

package
v3.0.1074+incompatible Latest Latest
Warning

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

Go to latest
Published: Nov 3, 2024 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"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// 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 increase the number of disks during rolling restart of scaled-out compute resources.
	FAILEDOPERATION_UNSUPPORTRESETNODETYPEANDSCALEOUTDISK = "FailedOperation.UnsupportResetNodeTypeAndScaleoutDisk"

	// The disk capacity can’t be modified during rolling restart of scaled-in compute resources.
	FAILEDOPERATION_UNSUPPORTRESETSCALEDOWNANDMODIFYDISK = "FailedOperation.UnsupportResetScaledownAndModifyDisk"

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

	// Internal error.
	INTERNALERROR = "InternalError"

	// Invalid parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Incorrect parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

	// The number of requests exceeds the frequency limit.
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// 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"

	// Unauthorized operation.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// Unknown parameter error.
	UNKNOWNPARAMETER = "UnknownParameter"

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

Variables

This section is empty.

Functions

This section is empty.

Types

type BackingIndexMetaField

type BackingIndexMetaField struct {
	// Backing index name
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// Backing index status
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexStatus *string `json:"IndexStatus,omitnil,omitempty" name:"IndexStatus"`

	// Backing index size
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexStorage *int64 `json:"IndexStorage,omitnil,omitempty" name:"IndexStorage"`

	// Current lifecycle phase of backing index
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexPhrase *string `json:"IndexPhrase,omitnil,omitempty" name:"IndexPhrase"`

	// Backing index creation time
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexCreateTime *string `json:"IndexCreateTime,omitnil,omitempty" name:"IndexCreateTime"`
}

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

func (c *Client) CreateIndex(request *CreateIndexRequest) (response *CreateIndexResponse, err error)

CreateIndex This API is used to create indices.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateIndexWithContext

func (c *Client) CreateIndexWithContext(ctx context.Context, request *CreateIndexRequest) (response *CreateIndexResponse, err error)

CreateIndex This API is used to create indices.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

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:

AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
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:

AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
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) DeleteIndex

func (c *Client) DeleteIndex(request *DeleteIndexRequest) (response *DeleteIndexResponse, err error)

DeleteIndex This API is used to delete indices.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteIndexWithContext

func (c *Client) DeleteIndexWithContext(ctx context.Context, request *DeleteIndexRequest) (response *DeleteIndexResponse, err error)

DeleteIndex This API is used to delete indices.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

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

func (c *Client) DescribeIndexList(request *DescribeIndexListRequest) (response *DescribeIndexListResponse, err error)

DescribeIndexList This API is used to obtain the index list.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeIndexListWithContext

func (c *Client) DescribeIndexListWithContext(ctx context.Context, request *DescribeIndexListRequest) (response *DescribeIndexListResponse, err error)

DescribeIndexList This API is used to obtain the index list.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeIndexMeta

func (c *Client) DescribeIndexMeta(request *DescribeIndexMetaRequest) (response *DescribeIndexMetaResponse, err error)

DescribeIndexMeta This API is used to obtain index metadata.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeIndexMetaWithContext

func (c *Client) DescribeIndexMetaWithContext(ctx context.Context, request *DescribeIndexMetaRequest) (response *DescribeIndexMetaResponse, err error)

DescribeIndexMeta This API is used to obtain index metadata.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
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"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

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"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

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:

FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
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:

FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
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) UpdateDictionaries

func (c *Client) UpdateDictionaries(request *UpdateDictionariesRequest) (response *UpdateDictionariesResponse, err error)

UpdateDictionaries This API is used to update ES cluster dictionaries.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) UpdateDictionariesWithContext

func (c *Client) UpdateDictionariesWithContext(ctx context.Context, request *UpdateDictionariesRequest) (response *UpdateDictionariesResponse, err error)

UpdateDictionaries This API is used to update ES cluster dictionaries.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) UpdateIndex

func (c *Client) UpdateIndex(request *UpdateIndexRequest) (response *UpdateIndexResponse, err error)

UpdateIndex This API is used to update indices.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateIndexWithContext

func (c *Client) UpdateIndexWithContext(ctx context.Context, request *UpdateIndexRequest) (response *UpdateIndexResponse, err error)

UpdateIndex This API is used to update indices.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnAuthorizedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ERRORCLUSTERSTATE = "FailedOperation.ErrorClusterState"
FAILEDOPERATION_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
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_UNSUPPORTRESETNODETYPEANDSCALEOUTDISK = "FailedOperation.UnsupportResetNodeTypeAndScaleoutDisk"
FAILEDOPERATION_UNSUPPORTRESETSCALEDOWNANDMODIFYDISK = "FailedOperation.UnsupportResetScaledownAndModifyDisk"
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_UNSUPPORTRESETNODETYPEANDSCALEOUTDISK = "FailedOperation.UnsupportResetNodeTypeAndScaleoutDisk"
FAILEDOPERATION_UNSUPPORTRESETSCALEDOWNANDMODIFYDISK = "FailedOperation.UnsupportResetScaledownAndModifyDisk"
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_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
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_ERRORCLUSTERSTATEUNHEALTH = "FailedOperation.ErrorClusterStateUnhealth"
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,omitnil,omitempty" name:"Health"`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// Total COS storage of an enterprise cluster, in GB
	TotalCosStorage *int64 `json:"TotalCosStorage,omitnil,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,omitnil,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,omitnil,omitempty" name:"SearchableSnapshotCosAppId"`
}

type CosBackup

type CosBackup struct {
	// Whether to enable auto-backup to COS
	IsAutoBackup *bool `json:"IsAutoBackup,omitnil,omitempty" name:"IsAutoBackup"`

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

type CreateIndexRequest

type CreateIndexRequest struct {
	*tchttp.BaseRequest

	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Type of the index to create. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// Name of the index to create
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// JSON-formatted index metadata to create, such as `mappings` and `settings`
	IndexMetaJson *string `json:"IndexMetaJson,omitnil,omitempty" name:"IndexMetaJson"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`
}

func NewCreateIndexRequest

func NewCreateIndexRequest() (request *CreateIndexRequest)

func (*CreateIndexRequest) FromJsonString

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

func (r *CreateIndexRequest) ToJsonString() string

type CreateIndexRequestParams

type CreateIndexRequestParams struct {
	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Type of the index to create. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// Name of the index to create
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// JSON-formatted index metadata to create, such as `mappings` and `settings`
	IndexMetaJson *string `json:"IndexMetaJson,omitnil,omitempty" name:"IndexMetaJson"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`
}

Predefined struct for user

type CreateIndexResponse

type CreateIndexResponse struct {
	*tchttp.BaseResponse
	Response *CreateIndexResponseParams `json:"Response"`
}

func NewCreateIndexResponse

func NewCreateIndexResponse() (response *CreateIndexResponse)

func (*CreateIndexResponse) FromJsonString

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

func (r *CreateIndexResponse) ToJsonString() string

type CreateIndexResponseParams

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

Predefined struct for user

type CreateInstanceRequest

type CreateInstanceRequest struct {
	*tchttp.BaseRequest

	// Availability Zone
	Zone *string `json:"Zone,omitnil,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,omitnil,omitempty" name:"EsVersion"`

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

	// Subnet ID
	SubnetId *string `json:"SubnetId,omitnil,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,omitnil,omitempty" name:"Password"`

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

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

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

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

	// This parameter is not used on the global website
	RenewFlag *string `json:"RenewFlag,omitnil,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,omitnil,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,omitnil,omitempty" name:"DiskType"`

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

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

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

	// List of voucher IDs (only one voucher can be specified at a time currently)
	VoucherIds []*string `json:"VoucherIds,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"DeployMode"`

	// Details of AZs in multi-AZ deployment mode (which is required when DeployMode is 1)
	MultiZoneInfo []*ZoneDetail `json:"MultiZoneInfo,omitnil,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,omitnil,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,omitnil,omitempty" name:"NodeInfoList"`

	// Node tag information list
	TagList []*TagInfo `json:"TagList,omitnil,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,omitnil,omitempty" name:"BasicSecurityType"`

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

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

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

	// The maintenance time slot
	OperationDuration *OperationDuration `json:"OperationDuration,omitnil,omitempty" name:"OperationDuration"`

	// Whether to enable the storage-computing separation feature.
	EnableHybridStorage *bool `json:"EnableHybridStorage,omitnil,omitempty" name:"EnableHybridStorage"`

	// Whether to enable enhanced SSD
	DiskEnhance *uint64 `json:"DiskEnhance,omitnil,omitempty" name:"DiskEnhance"`

	// Whether to enable smart inspection.
	EnableDiagnose *bool `json:"EnableDiagnose,omitnil,omitempty" name:"EnableDiagnose"`
}

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 CreateInstanceRequestParams

type CreateInstanceRequestParams struct {
	// Availability Zone
	Zone *string `json:"Zone,omitnil,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,omitnil,omitempty" name:"EsVersion"`

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

	// Subnet ID
	SubnetId *string `json:"SubnetId,omitnil,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,omitnil,omitempty" name:"Password"`

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

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

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

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

	// This parameter is not used on the global website
	RenewFlag *string `json:"RenewFlag,omitnil,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,omitnil,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,omitnil,omitempty" name:"DiskType"`

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

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

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

	// List of voucher IDs (only one voucher can be specified at a time currently)
	VoucherIds []*string `json:"VoucherIds,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"DeployMode"`

	// Details of AZs in multi-AZ deployment mode (which is required when DeployMode is 1)
	MultiZoneInfo []*ZoneDetail `json:"MultiZoneInfo,omitnil,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,omitnil,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,omitnil,omitempty" name:"NodeInfoList"`

	// Node tag information list
	TagList []*TagInfo `json:"TagList,omitnil,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,omitnil,omitempty" name:"BasicSecurityType"`

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

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

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

	// The maintenance time slot
	OperationDuration *OperationDuration `json:"OperationDuration,omitnil,omitempty" name:"OperationDuration"`

	// Whether to enable the storage-computing separation feature.
	EnableHybridStorage *bool `json:"EnableHybridStorage,omitnil,omitempty" name:"EnableHybridStorage"`

	// Whether to enable enhanced SSD
	DiskEnhance *uint64 `json:"DiskEnhance,omitnil,omitempty" name:"DiskEnhance"`

	// Whether to enable smart inspection.
	EnableDiagnose *bool `json:"EnableDiagnose,omitnil,omitempty" name:"EnableDiagnose"`
}

Predefined struct for user

type CreateInstanceResponse

type CreateInstanceResponse struct {
	*tchttp.BaseResponse
	Response *CreateInstanceResponseParams `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 CreateInstanceResponseParams

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

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

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

Predefined struct for user

type DeleteIndexRequest

type DeleteIndexRequest struct {
	*tchttp.BaseRequest

	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Type of the index to delete. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// Name of the index to delete
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// Backing index name
	BackingIndexName *string `json:"BackingIndexName,omitnil,omitempty" name:"BackingIndexName"`
}

func NewDeleteIndexRequest

func NewDeleteIndexRequest() (request *DeleteIndexRequest)

func (*DeleteIndexRequest) FromJsonString

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

func (r *DeleteIndexRequest) ToJsonString() string

type DeleteIndexRequestParams

type DeleteIndexRequestParams struct {
	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Type of the index to delete. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// Name of the index to delete
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// Backing index name
	BackingIndexName *string `json:"BackingIndexName,omitnil,omitempty" name:"BackingIndexName"`
}

Predefined struct for user

type DeleteIndexResponse

type DeleteIndexResponse struct {
	*tchttp.BaseResponse
	Response *DeleteIndexResponseParams `json:"Response"`
}

func NewDeleteIndexResponse

func NewDeleteIndexResponse() (response *DeleteIndexResponse)

func (*DeleteIndexResponse) FromJsonString

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

func (r *DeleteIndexResponse) ToJsonString() string

type DeleteIndexResponseParams

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

Predefined struct for user

type DeleteInstanceRequest

type DeleteInstanceRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,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 DeleteInstanceRequestParams

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

Predefined struct for user

type DeleteInstanceResponse

type DeleteInstanceResponse struct {
	*tchttp.BaseResponse
	Response *DeleteInstanceResponseParams `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 DeleteInstanceResponseParams

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

Predefined struct for user

type DescribeIndexListRequest

type DescribeIndexListRequest struct {
	*tchttp.BaseRequest

	// Index type. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Index name. `null` indicates that all indexes are requested.
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// The starting position of paging
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// The number of results per page
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// Filtering by index status
	IndexStatusList []*string `json:"IndexStatusList,omitnil,omitempty" name:"IndexStatusList"`

	// Sorting mode, which can be `asc` and `desc`.
	Order *string `json:"Order,omitnil,omitempty" name:"Order"`
}

func NewDescribeIndexListRequest

func NewDescribeIndexListRequest() (request *DescribeIndexListRequest)

func (*DescribeIndexListRequest) FromJsonString

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

func (r *DescribeIndexListRequest) ToJsonString() string

type DescribeIndexListRequestParams

type DescribeIndexListRequestParams struct {
	// Index type. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Index name. `null` indicates that all indexes are requested.
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// The starting position of paging
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// The number of results per page
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// Filtering by index status
	IndexStatusList []*string `json:"IndexStatusList,omitnil,omitempty" name:"IndexStatusList"`

	// Sorting mode, which can be `asc` and `desc`.
	Order *string `json:"Order,omitnil,omitempty" name:"Order"`
}

Predefined struct for user

type DescribeIndexListResponse

type DescribeIndexListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeIndexListResponseParams `json:"Response"`
}

func NewDescribeIndexListResponse

func NewDescribeIndexListResponse() (response *DescribeIndexListResponse)

func (*DescribeIndexListResponse) FromJsonString

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

func (r *DescribeIndexListResponse) ToJsonString() string

type DescribeIndexListResponseParams

type DescribeIndexListResponseParams struct {
	// Index metadata field
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexMetaFields []*IndexMetaField `json:"IndexMetaFields,omitnil,omitempty" name:"IndexMetaFields"`

	// Total number of results
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeIndexMetaRequest

type DescribeIndexMetaRequest struct {
	*tchttp.BaseRequest

	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Index type. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// Index name. `null` indicates that all indexes are requested.
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`
}

func NewDescribeIndexMetaRequest

func NewDescribeIndexMetaRequest() (request *DescribeIndexMetaRequest)

func (*DescribeIndexMetaRequest) FromJsonString

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

func (r *DescribeIndexMetaRequest) ToJsonString() string

type DescribeIndexMetaRequestParams

type DescribeIndexMetaRequestParams struct {
	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Index type. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// Index name. `null` indicates that all indexes are requested.
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`
}

Predefined struct for user

type DescribeIndexMetaResponse

type DescribeIndexMetaResponse struct {
	*tchttp.BaseResponse
	Response *DescribeIndexMetaResponseParams `json:"Response"`
}

func NewDescribeIndexMetaResponse

func NewDescribeIndexMetaResponse() (response *DescribeIndexMetaResponse)

func (*DescribeIndexMetaResponse) FromJsonString

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

func (r *DescribeIndexMetaResponse) ToJsonString() string

type DescribeIndexMetaResponseParams

type DescribeIndexMetaResponseParams struct {
	// Index metadata field
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexMetaField *IndexMetaField `json:"IndexMetaField,omitnil,omitempty" name:"IndexMetaField"`

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

Predefined struct for user

type DescribeInstanceLogsRequest

type DescribeInstanceLogsRequest struct {
	*tchttp.BaseRequest

	// Cluster instance ID
	InstanceId *string `json:"InstanceId,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"EndTime"`

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

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

	// Time sorting order. Default value: 0
	// <li>0: descending</li>
	// <li>1: ascending</li>
	OrderByType *uint64 `json:"OrderByType,omitnil,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 DescribeInstanceLogsRequestParams

type DescribeInstanceLogsRequestParams struct {
	// Cluster instance ID
	InstanceId *string `json:"InstanceId,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"EndTime"`

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

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

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

Predefined struct for user

type DescribeInstanceLogsResponse

type DescribeInstanceLogsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceLogsResponseParams `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 DescribeInstanceLogsResponseParams

type DescribeInstanceLogsResponseParams struct {
	// Number of returned logs
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

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

Predefined struct for user

type DescribeInstanceOperationsRequest

type DescribeInstanceOperationsRequest struct {
	*tchttp.BaseRequest

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

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

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

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

	// Number of entries per page
	Limit *uint64 `json:"Limit,omitnil,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 DescribeInstanceOperationsRequestParams

type DescribeInstanceOperationsRequestParams struct {
	// Cluster instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

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

Predefined struct for user

type DescribeInstanceOperationsResponse

type DescribeInstanceOperationsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceOperationsResponseParams `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 DescribeInstanceOperationsResponseParams

type DescribeInstanceOperationsResponseParams struct {
	// Total number of operation records
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

	// The unique request ID, which is returned for each request. 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

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

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

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

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

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

	// The sorting field. <li>1: Instance ID </li><li>2: Instance name </li><li>3: AZ </li><li>4: Creation time </li>If `OrderByKey` is not passed in, sorting is performed by creation time in descending order.
	OrderByKey *uint64 `json:"OrderByKey,omitnil,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,omitnil,omitempty" name:"OrderByType"`

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

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

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

	// The health status filter. Valid values: `0` (green), `1` (yellow), `2` (red), `-1` (unknown).
	HealthStatus []*int64 `json:"HealthStatus,omitnil,omitempty" name:"HealthStatus"`

	// VPC IDs
	VpcIds []*string `json:"VpcIds,omitnil,omitempty" name:"VpcIds"`
}

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 {
	// AZ of the cluster instance. If this is not passed in, all AZs are used by default
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

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

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

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

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

	// The sorting field. <li>1: Instance ID </li><li>2: Instance name </li><li>3: AZ </li><li>4: Creation time </li>If `OrderByKey` is not passed in, sorting is performed by creation time in descending order.
	OrderByKey *uint64 `json:"OrderByKey,omitnil,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,omitnil,omitempty" name:"OrderByType"`

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

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

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

	// The health status filter. Valid values: `0` (green), `1` (yellow), `2` (red), `-1` (unknown).
	HealthStatus []*int64 `json:"HealthStatus,omitnil,omitempty" name:"HealthStatus"`

	// VPC IDs
	VpcIds []*string `json:"VpcIds,omitnil,omitempty" name:"VpcIds"`
}

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 {
	// Number of returned instances
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

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

Predefined struct for user

type DescribeViewsRequest

type DescribeViewsRequest struct {
	*tchttp.BaseRequest

	// Cluster instance ID
	InstanceId *string `json:"InstanceId,omitnil,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 DescribeViewsRequestParams

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

Predefined struct for user

type DescribeViewsResponse

type DescribeViewsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeViewsResponseParams `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 DescribeViewsResponseParams

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

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

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

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

Predefined struct for user

type DictInfo

type DictInfo struct {
	// Dictionary key value
	Key *string `json:"Key,omitnil,omitempty" name:"Key"`

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

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

type EsAcl

type EsAcl struct {
	// Kibana access blocklist
	BlackIpList []*string `json:"BlackIpList,omitnil,omitempty" name:"BlackIpList"`

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

type EsConfigSetInfo

type EsConfigSetInfo struct {
	// Configuration set type, such as `LDAP` and `AD`.
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// "{\"order\":0,\"url\":\"ldap://10.0.1.72:389\",\"bind_dn\":\"cn=admin,dc=tencent,dc=com\",\"user_search.base_dn\":\"dc=tencent,dc=com\",\"user_search.filter\":\"(cn={0})\",\"group_search.base_dn\":\"dc=tencent,dc=com\"}"
	EsConfig *string `json:"EsConfig,omitnil,omitempty" name:"EsConfig"`
}

type EsDictionaryInfo

type EsDictionaryInfo struct {
	// List of non-stop words
	MainDict []*DictInfo `json:"MainDict,omitnil,omitempty" name:"MainDict"`

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

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

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

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

type EsPublicAcl

type EsPublicAcl struct {
	// Access blocklist
	BlackIpList []*string `json:"BlackIpList,omitnil,omitempty" name:"BlackIpList"`

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

type GetRequestTargetNodeTypesRequest

type GetRequestTargetNodeTypesRequest struct {
	*tchttp.BaseRequest

	// Instance ID.
	InstanceId *string `json:"InstanceId,omitnil,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 GetRequestTargetNodeTypesRequestParams

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

Predefined struct for user

type GetRequestTargetNodeTypesResponse

type GetRequestTargetNodeTypesResponse struct {
	*tchttp.BaseResponse
	Response *GetRequestTargetNodeTypesResponseParams `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 GetRequestTargetNodeTypesResponseParams

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

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

Predefined struct for user

type IndexMetaField

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

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

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

	// Index size (in byte)
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexStorage *int64 `json:"IndexStorage,omitnil,omitempty" name:"IndexStorage"`

	// Index creation time
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexCreateTime *string `json:"IndexCreateTime,omitnil,omitempty" name:"IndexCreateTime"`

	// Backing index
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	BackingIndices []*BackingIndexMetaField `json:"BackingIndices,omitnil,omitempty" name:"BackingIndices"`

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

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

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

	// Index lifecycle policy field
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexPolicyField *IndexPolicyField `json:"IndexPolicyField,omitnil,omitempty" name:"IndexPolicyField"`

	// Index automation field
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexOptionsField *IndexOptionsField `json:"IndexOptionsField,omitnil,omitempty" name:"IndexOptionsField"`

	// Index setting field
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	IndexSettingsField *IndexSettingsField `json:"IndexSettingsField,omitnil,omitempty" name:"IndexSettingsField"`

	// Cluster APP ID
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	AppId *uint64 `json:"AppId,omitnil,omitempty" name:"AppId"`

	// The number of index docs.
	// Note: This field may return null, indicating that no valid values can be obtained.
	IndexDocs *uint64 `json:"IndexDocs,omitnil,omitempty" name:"IndexDocs"`
}

type IndexOptionsField

type IndexOptionsField struct {
	// Max age for expiry purpose
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	ExpireMaxAge *string `json:"ExpireMaxAge,omitnil,omitempty" name:"ExpireMaxAge"`

	// Max size for expiry purpose
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	ExpireMaxSize *string `json:"ExpireMaxSize,omitnil,omitempty" name:"ExpireMaxSize"`

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

	// Whether to enable the dynamic rollover
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	RolloverDynamic *string `json:"RolloverDynamic,omitnil,omitempty" name:"RolloverDynamic"`

	// Whether to enable dynamic sharding
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	ShardNumDynamic *string `json:"ShardNumDynamic,omitnil,omitempty" name:"ShardNumDynamic"`

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

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

type IndexPolicyField

type IndexPolicyField struct {
	// Whether to enable the warm phase
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	WarmEnable *string `json:"WarmEnable,omitnil,omitempty" name:"WarmEnable"`

	// Min age before data transitions to the warm phase
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	WarmMinAge *string `json:"WarmMinAge,omitnil,omitempty" name:"WarmMinAge"`

	// Whether to enable the cold phase
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	ColdEnable *string `json:"ColdEnable,omitnil,omitempty" name:"ColdEnable"`

	// Min age before data transitions to the cold phase
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	ColdMinAge *string `json:"ColdMinAge,omitnil,omitempty" name:"ColdMinAge"`

	// Whether to enable the frozen phase
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	FrozenEnable *string `json:"FrozenEnable,omitnil,omitempty" name:"FrozenEnable"`

	// Min age before data transitions to the frozen phase
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	FrozenMinAge *string `json:"FrozenMinAge,omitnil,omitempty" name:"FrozenMinAge"`

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

type IndexSettingsField

type IndexSettingsField struct {
	// Number of primary shards
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	NumberOfShards *string `json:"NumberOfShards,omitnil,omitempty" name:"NumberOfShards"`

	// Number of replica shards
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	NumberOfReplicas *string `json:"NumberOfReplicas,omitnil,omitempty" name:"NumberOfReplicas"`

	// Index refresh interval
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	RefreshInterval *string `json:"RefreshInterval,omitnil,omitempty" name:"RefreshInterval"`
}

type InstanceInfo

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

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

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

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

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

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

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

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

	// Instance status. `0`: Processing; `1`: Normal; `-1`: `Stopped`; `-2`: Being terminated; `-3`: Terminated; `2`: Initializing during the cluster creation.
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

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

	// 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,omitnil,omitempty" name:"ChargeType"`

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

	// 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,omitnil,omitempty" name:"NodeType"`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// List of tags owned by the instance
	TagList []*TagInfo `json:"TagList,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"WarmNodeType"`

	// Number of warm nodes
	// Note: This field may return `null`, indicating that no valid value was found.
	WarmNodeNum *uint64 `json:"WarmNodeNum,omitnil,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,omitnil,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,omitnil,omitempty" name:"WarmMemSize"`

	// Warm node disk type
	// Note: This field may return `null`, indicating that no valid value was found.
	WarmDiskType *string `json:"WarmDiskType,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"PublicAccess"`

	// ES public access control configuration
	EsPublicAcl *EsAcl `json:"EsPublicAcl,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"SceneType"`

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

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

	// Visual node configuration
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	WebNodeTypeInfo *WebNodeTypeInfo `json:"WebNodeTypeInfo,omitnil,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,omitnil,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,omitnil,omitempty" name:"Protocol"`

	// Security group ID
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	SecurityGroups []*string `json:"SecurityGroups,omitnil,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,omitnil,omitempty" name:"ColdNodeType"`

	// Number of cold nodes
	// Note: This field may return `null`, indicating that no valid value was found.
	ColdNodeNum *uint64 `json:"ColdNodeNum,omitnil,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,omitnil,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,omitnil,omitempty" name:"ColdMemSize"`

	// Cold node disk type
	// Note: This field may return `null`, indicating that no valid value was found.
	ColdDiskType *string `json:"ColdDiskType,omitnil,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,omitnil,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,omitnil,omitempty" name:"FrozenNodeType"`

	// Number of frozen nodes
	// Note: This field may return `null`, indicating that no valid value was found.
	FrozenNodeNum *uint64 `json:"FrozenNodeNum,omitnil,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,omitnil,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,omitnil,omitempty" name:"FrozenMemSize"`

	// Frozen node disk type
	// Note: This field may return `null`, indicating that no valid value was found.
	FrozenDiskType *string `json:"FrozenDiskType,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"EsPrivateDomain"`

	// Configuration set info of the cluster.
	// Note: This field may return null, indicating that no valid values can be obtained.
	EsConfigSets []*EsConfigSetInfo `json:"EsConfigSets,omitnil,omitempty" name:"EsConfigSets"`

	// The maintenance time slot of the cluster
	// Note: This field may return null, indicating that no valid values can be obtained.
	OperationDuration *OperationDuration `json:"OperationDuration,omitnil,omitempty" name:"OperationDuration"`

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

	// Autonomous index option
	// Note: This field may return null, indicating that no valid values can be obtained.
	AutoIndexEnabled *bool `json:"AutoIndexEnabled,omitnil,omitempty" name:"AutoIndexEnabled"`

	// Whether the storage-computing separation feature is enabled.
	// Note: This field may return null, indicating that no valid values can be obtained.
	EnableHybridStorage *bool `json:"EnableHybridStorage,omitnil,omitempty" name:"EnableHybridStorage"`

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

	// The alerting policy of Kibana over the public network. <li>`OPEN`: Enable the policy;</li><li>`CLOSE`: Disable the policy.
	// Note: This field may return null, indicating that no valid values can be obtained.
	KibanaAlteringPublicAccess *string `json:"KibanaAlteringPublicAccess,omitnil,omitempty" name:"KibanaAlteringPublicAccess"`
}

type InstanceLog

type InstanceLog struct {
	// Log time
	Time *string `json:"Time,omitnil,omitempty" name:"Time"`

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

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

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

type KeyValue

type KeyValue struct {
	// Key
	Key *string `json:"Key,omitnil,omitempty" name:"Key"`

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

type KibanaNodeInfo

type KibanaNodeInfo struct {
	// Kibana node specification
	KibanaNodeType *string `json:"KibanaNodeType,omitnil,omitempty" name:"KibanaNodeType"`

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

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

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

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

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

type KibanaView

type KibanaView struct {
	// Kibana node IP
	Ip *string `json:"Ip,omitnil,omitempty" name:"Ip"`

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

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

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

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

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

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

	// Availability zone
	Zone *string `json:"Zone,omitnil,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,omitnil,omitempty" name:"LocalDiskType"`

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

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

type MasterNodeInfo

type MasterNodeInfo struct {
	// Whether to enable the dedicated primary node
	EnableDedicatedMaster *bool `json:"EnableDedicatedMaster,omitnil,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,omitnil,omitempty" name:"MasterNodeType"`

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

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

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

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

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

type NodeInfo

type NodeInfo struct {
	// Number of nodes
	NodeNum *uint64 `json:"NodeNum,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"DiskType"`

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

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

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

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

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

	// Memory size in GB
	// Note: This field may return null, indicating that no valid values can be obtained.
	MemSize *int64 `json:"MemSize,omitnil,omitempty" name:"MemSize"`

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

type NodeView

type NodeView struct {
	// Node ID
	NodeId *string `json:"NodeId,omitnil,omitempty" name:"NodeId"`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type Operation

type Operation struct {
	// Unique operation ID
	Id *uint64 `json:"Id,omitnil,omitempty" name:"Id"`

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

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

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

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

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

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

type OperationDetail

type OperationDetail struct {
	// Original instance configuration information
	OldInfo []*KeyValue `json:"OldInfo,omitnil,omitempty" name:"OldInfo"`

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

type OperationDuration

type OperationDuration struct {
	// Maintenance period, which can be one or more days from Monday to Sunday. Valid values: [0, 6].
	// Note: This field may return null, indicating that no valid values can be obtained.
	Periods []*uint64 `json:"Periods,omitnil,omitempty" name:"Periods"`

	// The maintenance start time
	TimeStart *string `json:"TimeStart,omitnil,omitempty" name:"TimeStart"`

	// The maintenance end time
	TimeEnd *string `json:"TimeEnd,omitnil,omitempty" name:"TimeEnd"`

	// The time zone expressed in UTC.
	TimeZone *string `json:"TimeZone,omitnil,omitempty" name:"TimeZone"`
}

type OperationDurationUpdated

type OperationDurationUpdated struct {
	// Maintenance period, which can be one or more days from Monday to Sunday. Valid values: [0, 6].
	Periods []*uint64 `json:"Periods,omitnil,omitempty" name:"Periods"`

	// The maintenance start time
	TimeStart *string `json:"TimeStart,omitnil,omitempty" name:"TimeStart"`

	// The maintenance end time
	TimeEnd *string `json:"TimeEnd,omitnil,omitempty" name:"TimeEnd"`

	// The time zone expressed in UTC.
	TimeZone *string `json:"TimeZone,omitnil,omitempty" name:"TimeZone"`

	// The array of ES cluster IDs
	MoreInstances []*string `json:"MoreInstances,omitnil,omitempty" name:"MoreInstances"`
}

type OptionalWebServiceInfo

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

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

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

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

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

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

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

type RestartInstanceRequest

type RestartInstanceRequest struct {
	*tchttp.BaseRequest

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

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

	// Restart mode. `0`: rolling restart; `1`: full restart
	RestartMode *int64 `json:"RestartMode,omitnil,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 RestartInstanceRequestParams

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

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

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

Predefined struct for user

type RestartInstanceResponse

type RestartInstanceResponse struct {
	*tchttp.BaseResponse
	Response *RestartInstanceResponseParams `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 RestartInstanceResponseParams

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

Predefined struct for user

type RestartKibanaRequest

type RestartKibanaRequest struct {
	*tchttp.BaseRequest

	// ES instance ID
	InstanceId *string `json:"InstanceId,omitnil,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 RestartKibanaRequestParams

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

Predefined struct for user

type RestartKibanaResponse

type RestartKibanaResponse struct {
	*tchttp.BaseResponse
	Response *RestartKibanaResponseParams `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 RestartKibanaResponseParams

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

Predefined struct for user

type RestartNodesRequest

type RestartNodesRequest struct {
	*tchttp.BaseRequest

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

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

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

	// The restart mode. Valid values: `in-place` (default), `blue-green`.
	RestartMode *string `json:"RestartMode,omitnil,omitempty" name:"RestartMode"`

	// The node status, applicable in the blue/green mode. The blue/green restart is risky if the node is offline.
	IsOffline *bool `json:"IsOffline,omitnil,omitempty" name:"IsOffline"`
}

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 RestartNodesRequestParams

type RestartNodesRequestParams struct {
	// Cluster instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

	// The restart mode. Valid values: `in-place` (default), `blue-green`.
	RestartMode *string `json:"RestartMode,omitnil,omitempty" name:"RestartMode"`

	// The node status, applicable in the blue/green mode. The blue/green restart is risky if the node is offline.
	IsOffline *bool `json:"IsOffline,omitnil,omitempty" name:"IsOffline"`
}

Predefined struct for user

type RestartNodesResponse

type RestartNodesResponse struct {
	*tchttp.BaseResponse
	Response *RestartNodesResponseParams `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 RestartNodesResponseParams

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

Predefined struct for user

type SubTaskDetail

type SubTaskDetail struct {
	// Subtask name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

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

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

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

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

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

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

type TagInfo

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

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

type TaskDetail

type TaskDetail struct {
	// Task name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

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

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

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

type UpdateDictionariesRequest

type UpdateDictionariesRequest struct {
	*tchttp.BaseRequest

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

	// COS address of the main dictionary for the IK analyzer
	IkMainDicts []*string `json:"IkMainDicts,omitnil,omitempty" name:"IkMainDicts"`

	// COS address of the stopword dictionary for the IK analyzer
	IkStopwords []*string `json:"IkStopwords,omitnil,omitempty" name:"IkStopwords"`

	// COS address of the synonym dictionary
	Synonym []*string `json:"Synonym,omitnil,omitempty" name:"Synonym"`

	// COS address of the QQ dictionary
	QQDict []*string `json:"QQDict,omitnil,omitempty" name:"QQDict"`

	// `0` (default): Install, `1`: Delete
	UpdateType *int64 `json:"UpdateType,omitnil,omitempty" name:"UpdateType"`

	// Whether to force restart the cluster. The default value is `false`.
	ForceRestart *bool `json:"ForceRestart,omitnil,omitempty" name:"ForceRestart"`
}

func NewUpdateDictionariesRequest

func NewUpdateDictionariesRequest() (request *UpdateDictionariesRequest)

func (*UpdateDictionariesRequest) FromJsonString

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

func (r *UpdateDictionariesRequest) ToJsonString() string

type UpdateDictionariesRequestParams

type UpdateDictionariesRequestParams struct {
	// ES instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// COS address of the main dictionary for the IK analyzer
	IkMainDicts []*string `json:"IkMainDicts,omitnil,omitempty" name:"IkMainDicts"`

	// COS address of the stopword dictionary for the IK analyzer
	IkStopwords []*string `json:"IkStopwords,omitnil,omitempty" name:"IkStopwords"`

	// COS address of the synonym dictionary
	Synonym []*string `json:"Synonym,omitnil,omitempty" name:"Synonym"`

	// COS address of the QQ dictionary
	QQDict []*string `json:"QQDict,omitnil,omitempty" name:"QQDict"`

	// `0` (default): Install, `1`: Delete
	UpdateType *int64 `json:"UpdateType,omitnil,omitempty" name:"UpdateType"`

	// Whether to force restart the cluster. The default value is `false`.
	ForceRestart *bool `json:"ForceRestart,omitnil,omitempty" name:"ForceRestart"`
}

Predefined struct for user

type UpdateDictionariesResponse

type UpdateDictionariesResponse struct {
	*tchttp.BaseResponse
	Response *UpdateDictionariesResponseParams `json:"Response"`
}

func NewUpdateDictionariesResponse

func NewUpdateDictionariesResponse() (response *UpdateDictionariesResponse)

func (*UpdateDictionariesResponse) FromJsonString

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

func (r *UpdateDictionariesResponse) ToJsonString() string

type UpdateDictionariesResponseParams

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

Predefined struct for user

type UpdateIndexRequest

type UpdateIndexRequest struct {
	*tchttp.BaseRequest

	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Type of the index to update. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// Name of the index to update
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// JSON-formatted index metadata to update, such as `mappings` and `settings`.
	UpdateMetaJson *string `json:"UpdateMetaJson,omitnil,omitempty" name:"UpdateMetaJson"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// Whether to roll over the backup index
	RolloverBackingIndex *bool `json:"RolloverBackingIndex,omitnil,omitempty" name:"RolloverBackingIndex"`
}

func NewUpdateIndexRequest

func NewUpdateIndexRequest() (request *UpdateIndexRequest)

func (*UpdateIndexRequest) FromJsonString

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

func (r *UpdateIndexRequest) ToJsonString() string

type UpdateIndexRequestParams

type UpdateIndexRequestParams struct {
	// ES cluster ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Type of the index to update. `auto`: Automated; `normal`: General.
	IndexType *string `json:"IndexType,omitnil,omitempty" name:"IndexType"`

	// Name of the index to update
	IndexName *string `json:"IndexName,omitnil,omitempty" name:"IndexName"`

	// JSON-formatted index metadata to update, such as `mappings` and `settings`.
	UpdateMetaJson *string `json:"UpdateMetaJson,omitnil,omitempty" name:"UpdateMetaJson"`

	// Username for cluster access
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// Password for cluster access
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// Whether to roll over the backup index
	RolloverBackingIndex *bool `json:"RolloverBackingIndex,omitnil,omitempty" name:"RolloverBackingIndex"`
}

Predefined struct for user

type UpdateIndexResponse

type UpdateIndexResponse struct {
	*tchttp.BaseResponse
	Response *UpdateIndexResponseParams `json:"Response"`
}

func NewUpdateIndexResponse

func NewUpdateIndexResponse() (response *UpdateIndexResponse)

func (*UpdateIndexResponse) FromJsonString

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

func (r *UpdateIndexResponse) ToJsonString() string

type UpdateIndexResponseParams

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

Predefined struct for user

type UpdateInstanceRequest

type UpdateInstanceRequest struct {
	*tchttp.BaseRequest

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

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

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

	// ES configuration item (JSON string)
	EsConfig *string `json:"EsConfig,omitnil,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,omitnil,omitempty" name:"Password"`

	// The policy for visual component (Kibana and Cerebro) access over public network.
	EsAcl *EsAcl `json:"EsAcl,omitnil,omitempty" name:"EsAcl"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Disk size in GB
	DiskSize *uint64 `json:"DiskSize,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"ForceRestart"`

	// Auto-backup to COS
	CosBackup *CosBackup `json:"CosBackup,omitnil,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,omitnil,omitempty" name:"NodeInfoList"`

	// The status of ES cluster access over public network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	PublicAccess *string `json:"PublicAccess,omitnil,omitempty" name:"PublicAccess"`

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

	// The status of Kibana access over public network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	KibanaPublicAccess *string `json:"KibanaPublicAccess,omitnil,omitempty" name:"KibanaPublicAccess"`

	// The status of Kibana access over private network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	KibanaPrivateAccess *string `json:"KibanaPrivateAccess,omitnil,omitempty" name:"KibanaPrivateAccess"`

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

	// Kibana private port
	KibanaPrivatePort *uint64 `json:"KibanaPrivatePort,omitnil,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,omitnil,omitempty" name:"ScaleType"`

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

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

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

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

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

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

	// The status of Cerebro access over public network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	CerebroPublicAccess *string `json:"CerebroPublicAccess,omitnil,omitempty" name:"CerebroPublicAccess"`

	// The status of Cerebro access over private network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	CerebroPrivateAccess *string `json:"CerebroPrivateAccess,omitnil,omitempty" name:"CerebroPrivateAccess"`

	// Added or modified configuration set information
	EsConfigSet *EsConfigSetInfo `json:"EsConfigSet,omitnil,omitempty" name:"EsConfigSet"`

	// The maintenance time slot
	OperationDuration *OperationDurationUpdated `json:"OperationDuration,omitnil,omitempty" name:"OperationDuration"`

	// Whether to enable the option for sending alerting messages over the public network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	KibanaAlteringPublicAccess *string `json:"KibanaAlteringPublicAccess,omitnil,omitempty" name:"KibanaAlteringPublicAccess"`
}

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 UpdateInstanceRequestParams

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

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

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

	// ES configuration item (JSON string)
	EsConfig *string `json:"EsConfig,omitnil,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,omitnil,omitempty" name:"Password"`

	// The policy for visual component (Kibana and Cerebro) access over public network.
	EsAcl *EsAcl `json:"EsAcl,omitnil,omitempty" name:"EsAcl"`

	// This parameter has been disused. Please use `NodeInfoList`
	// Disk size in GB
	DiskSize *uint64 `json:"DiskSize,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"ForceRestart"`

	// Auto-backup to COS
	CosBackup *CosBackup `json:"CosBackup,omitnil,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,omitnil,omitempty" name:"NodeInfoList"`

	// The status of ES cluster access over public network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	PublicAccess *string `json:"PublicAccess,omitnil,omitempty" name:"PublicAccess"`

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

	// The status of Kibana access over public network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	KibanaPublicAccess *string `json:"KibanaPublicAccess,omitnil,omitempty" name:"KibanaPublicAccess"`

	// The status of Kibana access over private network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	KibanaPrivateAccess *string `json:"KibanaPrivateAccess,omitnil,omitempty" name:"KibanaPrivateAccess"`

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

	// Kibana private port
	KibanaPrivatePort *uint64 `json:"KibanaPrivatePort,omitnil,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,omitnil,omitempty" name:"ScaleType"`

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

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

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

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

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

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

	// The status of Cerebro access over public network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	CerebroPublicAccess *string `json:"CerebroPublicAccess,omitnil,omitempty" name:"CerebroPublicAccess"`

	// The status of Cerebro access over private network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	CerebroPrivateAccess *string `json:"CerebroPrivateAccess,omitnil,omitempty" name:"CerebroPrivateAccess"`

	// Added or modified configuration set information
	EsConfigSet *EsConfigSetInfo `json:"EsConfigSet,omitnil,omitempty" name:"EsConfigSet"`

	// The maintenance time slot
	OperationDuration *OperationDurationUpdated `json:"OperationDuration,omitnil,omitempty" name:"OperationDuration"`

	// Whether to enable the option for sending alerting messages over the public network.
	// `OPEN`: Enabled.
	// `CLOSE`: Disabled.
	KibanaAlteringPublicAccess *string `json:"KibanaAlteringPublicAccess,omitnil,omitempty" name:"KibanaAlteringPublicAccess"`
}

Predefined struct for user

type UpdateInstanceResponse

type UpdateInstanceResponse struct {
	*tchttp.BaseResponse
	Response *UpdateInstanceResponseParams `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 UpdateInstanceResponseParams

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

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

Predefined struct for user

type UpdatePluginsRequest

type UpdatePluginsRequest struct {
	*tchttp.BaseRequest

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

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

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

	// Whether to force restart the cluster. The default value is `false`.
	ForceRestart *bool `json:"ForceRestart,omitnil,omitempty" name:"ForceRestart"`

	// Whether to reinstall the cluster. The default value is `false`.
	ForceUpdate *bool `json:"ForceUpdate,omitnil,omitempty" name:"ForceUpdate"`

	// 0: system plugin
	PluginType *uint64 `json:"PluginType,omitnil,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 UpdatePluginsRequestParams

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

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

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

	// Whether to force restart the cluster. The default value is `false`.
	ForceRestart *bool `json:"ForceRestart,omitnil,omitempty" name:"ForceRestart"`

	// Whether to reinstall the cluster. The default value is `false`.
	ForceUpdate *bool `json:"ForceUpdate,omitnil,omitempty" name:"ForceUpdate"`

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

Predefined struct for user

type UpdatePluginsResponse

type UpdatePluginsResponse struct {
	*tchttp.BaseResponse
	Response *UpdatePluginsResponseParams `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 UpdatePluginsResponseParams

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

Predefined struct for user

type UpdateRequestTargetNodeTypesRequest

type UpdateRequestTargetNodeTypesRequest struct {
	*tchttp.BaseRequest

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

	// A list of node types used to receive requests.
	TargetNodeTypes []*string `json:"TargetNodeTypes,omitnil,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 UpdateRequestTargetNodeTypesRequestParams

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

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

Predefined struct for user

type UpdateRequestTargetNodeTypesResponse

type UpdateRequestTargetNodeTypesResponse struct {
	*tchttp.BaseResponse
	Response *UpdateRequestTargetNodeTypesResponseParams `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 UpdateRequestTargetNodeTypesResponseParams

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

Predefined struct for user

type UpgradeInstanceRequest

type UpgradeInstanceRequest struct {
	*tchttp.BaseRequest

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

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

	// Whether to check for upgrade only. Default value: false
	CheckOnly *bool `json:"CheckOnly,omitnil,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,omitnil,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,omitnil,omitempty" name:"BasicSecurityType"`

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

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

	// Whether to skip the check and perform a force restart in the rolling mode. Default value: `false`.
	SkipCheckForceRestart *bool `json:"SkipCheckForceRestart,omitnil,omitempty" name:"SkipCheckForceRestart"`
}

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 UpgradeInstanceRequestParams

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

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

	// Whether to check for upgrade only. Default value: false
	CheckOnly *bool `json:"CheckOnly,omitnil,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,omitnil,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,omitnil,omitempty" name:"BasicSecurityType"`

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

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

	// Whether to skip the check and perform a force restart in the rolling mode. Default value: `false`.
	SkipCheckForceRestart *bool `json:"SkipCheckForceRestart,omitnil,omitempty" name:"SkipCheckForceRestart"`
}

Predefined struct for user

type UpgradeInstanceResponse

type UpgradeInstanceResponse struct {
	*tchttp.BaseResponse
	Response *UpgradeInstanceResponseParams `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 UpgradeInstanceResponseParams

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

Predefined struct for user

type UpgradeLicenseRequest

type UpgradeLicenseRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,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,omitnil,omitempty" name:"LicenseType"`

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

	// List of voucher IDs (only one voucher can be specified at a time currently)
	VoucherIds []*string `json:"VoucherIds,omitnil,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,omitnil,omitempty" name:"BasicSecurityType"`

	// Whether to force restart <li>true: yes </li><li>false: no </li>Default value: false
	ForceRestart *bool `json:"ForceRestart,omitnil,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 UpgradeLicenseRequestParams

type UpgradeLicenseRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,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,omitnil,omitempty" name:"LicenseType"`

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

	// List of voucher IDs (only one voucher can be specified at a time currently)
	VoucherIds []*string `json:"VoucherIds,omitnil,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,omitnil,omitempty" name:"BasicSecurityType"`

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

Predefined struct for user

type UpgradeLicenseResponse

type UpgradeLicenseResponse struct {
	*tchttp.BaseResponse
	Response *UpgradeLicenseResponseParams `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 UpgradeLicenseResponseParams

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

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

Predefined struct for user

type WebNodeTypeInfo

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

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

type ZoneDetail

type ZoneDetail struct {
	// AZ
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

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

Jump to

Keyboard shortcuts

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