Example Requests
Add independent master and client nodes.
-
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent
+Request Example
Add the master and client nodes.
+
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent
{
"type" : {
@@ -149,44 +147,44 @@
}
}
Example Responses
Status code: 200
-
Request succeeded.
-
{
+Response Example
Status code: 200
+
The request is processed.
+
{
"id" : "320afa24-ff2a-4f44-8460-6ba95e512ad4"
}
Status Codes
-
Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | The request is processed.
|
-403
+ | 403
|
-Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
+ | The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it.
|
-500
+ | 500
|
-The server has received the request but could not understand it.
+ | The server can be accessed by the request, but it cannot understand the user's request.
|
Configuring the Security Mode.
-FunctionThis API is used to configure the security mode of a cluster.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/mode/change
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-Cluster ID.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-authorityEnable
- |
-Yes
- |
-Boolean
- |
-Security mode. Its value can be:
-true: enabled
-false: disabled
-Default value: true
-
- |
-
-adminPwd
- |
-No
- |
-String
- |
-Cluster password in security mode.
- |
-
-httpsEnable
- |
-Yes
- |
-Boolean
- |
-Enable HTTPS. Its value can be:
-true: enabled
-false: disabled
-Default value: true
-
- |
-
-
-
-
-
- Response ParametersNone
-
- Example RequestsChange the security mode of the current cluster.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/mode/change
-
-{
- "authorityEnable" : true,
- "adminPwd" : "admin@1234",
- "httpsEnable" : true
-}
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-404
- |
-The requested resource could not be found.
-Modify the request before retry.
- |
-
-
-
-
-
-
- Changing the Security Group
-FunctionThis API is used to change the security group after a cluster is created.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/sg/change
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-Cluster ID.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-security_group_ids
- |
-Yes
- |
-String
- |
-Security group ID.
- |
-
-
-
-
-
- Response ParametersNone
-
- Example RequestsChange the security group that the current cluster belongs to.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/sg/change
-
-{
- "security_group_ids" : "b1038649-1f77-4ae9-b64d-9af56e422652"
-}
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-The client should not repeat the request without modifications.
- |
-
-403
- |
-Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
- |
-
-
-
-
-
-
- Configuring the Automatic Snapshot Creation Policy
-FunctionThis API is used to configure automatic snapshot creation. By default, a snapshot is created every day.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster for which you want to create snapshots automatically.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-indices
- |
-No
- |
-String
- |
-Name of the index to be backed up. * indicates all indexes.
- |
-
-prefix
- |
-No
- |
-String
- |
-Prefix of a snapshot that is automatically created, which is manually entered.
-Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
- NOTE: This parameter is mandatory when enable is set to true.
-
- |
-
-period
- |
-No
- |
-String
- |
-Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.
- NOTE: The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful. This parameter is mandatory when enable is set to true.
-
- |
-
-keepday
- |
-No
- |
-Integer
- |
-Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.
- NOTE: This parameter is mandatory when enable is set to true.
-
- |
-
-enable
- |
-Yes
- |
-String
- |
-Whether to enable the automatic snapshot creation policy.
-true: The automatic snapshot creation policy is enabled.
-false:The automatic snapshot creation policy is disabled, and other parameters do not need to be delivered.
-
- |
-
-deleteAuto
- |
-No
- |
-String
- |
-Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled. The default value is false, indicating that automatically created snapshots will not be deleted. If this parameter is set to true, all created snapshots will be deleted when the automatic snapshot creation policy is disabled.
- |
-
-frequency
- |
-No
- |
-String
- |
-Frequency of automatically creating snapshots.
- NOTE: The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
-
- |
-
-
-
-
-
- Response ParametersNone
-
- Example RequestsConfigure the automatic snapshot creation policy.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy
-
-{
- "prefix" : "snapshot",
- "period" : "16:00 GMT+08:00",
- "keepday" : 7,
- "frequency" : "DAY",
- "enable" : "true",
- "deleteAuto" : "false"
-}
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-406
- |
-The server could not fulfill the request according to the content characteristics of the request.
- |
-
-
-
-
-
-
- Enabling Public Network Access
-FunctionThis API is used to enable public network access.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/public/open
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster whose public network access you want to enable.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-eip
- |
-Yes
- |
-BindPublicReqEip object
- |
-EIP information.
- |
-
-
-
-
-
- Table 3 BindPublicReqEipParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-bandWidth
- |
-Yes
- |
-BindPublicReqEipBandWidth object
- |
-Public network bandwidth.
- |
-
-
-
-
-
- Table 4 BindPublicReqEipBandWidthParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-size
- |
-Yes
- |
-Integer
- |
-Bandwidth range. Unit: Mbit/s
- |
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 5 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-action
- |
-String
- |
-Operations. The fixed value is bindZone, indicating that the binding is successful.
- |
-
-
-
-
-
- Example Requests{
- "eip" : {
- "bandWidth" : {
- "size" : 5
- }
- }
-}
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "action" : "bindZone"
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Creating a cluster
-FunctionThis API is used to create a cluster.
-
- URIPOST /v1.0/{project_id}/clusters
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-cluster
- |
-Yes
- |
-CreateClusterBody object
- |
-Cluster object.
- |
-
-
-
-
-
- Table 3 CreateClusterBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-instance
- |
-Yes
- |
-CreateClusterInstanceBody object
- |
-Instance.
- |
-
-datastore
- |
-Yes
- |
-CreateClusterDatastoreBody object
- |
-Search engine.
- |
-
-name
- |
-Yes
- |
-String
- |
-Cluster name It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.
- |
-
-instanceNum
- |
-Yes
- |
-Integer
- |
-Number of clusters. The value range is 1 to 32.
- |
-
-backupStrategy
- |
-No
- |
-CreateClusterBackupStrategyBody object
- |
-Automatic snapshot creation policy, which is disabled by default.
-The automatic snapshot creation policy is enabled only if backupStrategy is not left blank.
- |
-
-httpsEnable
- |
-No
- |
-Boolean
- |
-Whether communication is encrypted on the cluster. The value can be true or false. By default, communication encryption is disabled. If httpsEnable is set to true, authorityEnable must be set to true.
-
-This parameter is supported in clusters 6.5.4 or later.
- |
-
-authorityEnable
- |
-No
- |
-Boolean
- |
-Whether to enable authentication. The value can be true or false. Authentication is disabled by default.
-
-This parameter is supported in clusters 6.5.4 or later.
- |
-
-adminPwd
- |
-No
- |
-String
- |
-Password of the cluster user admin in security mode. This parameter is mandatory only if authorityEnable is set to true.
-
- |
-
-enterprise_project_id
- |
-No
- |
-String
- |
-Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
- |
-
-tags
- |
-No
- |
-Array of CreateClusterTagsBody objects
- |
-Cluster tag.
- |
-
-ipv6_enable
- |
-No
- |
-Boolean
- |
-Whether to enable automatic IPv6 address assignment for the cluster. The default value is false.
- |
-
-
-
-
-
- Table 4 CreateClusterInstanceBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-flavorRef
- |
-Yes
- |
-String
- |
-Instance flavor. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.
- |
-
-volume
- |
-Yes
- |
-CreateClusterInstanceVolumeBody object
- |
-Volume information. You do not need to set this parameter when flavorRef is set to a local disk flavor. Currently, the following local disk flavors are supported:
-ess.spec-i3small
-ess.spec-i3medium
-ess.spec-i3.8xlarge.8
-ess.spec-ds.xlarge.8
-ess.spec-ds.2xlarge.8
-ess.spec-ds.4xlarge.8
-
- |
-
-nics
- |
-Yes
- |
-CreateClusterInstanceNicsBody object
- |
-Subnet ID.
- |
-
-availability_zone
- |
-Yes
- |
-String
- |
-Availability zone (AZ). You need to specify the AZ name.
-By default, a single AZ is specified. If multiple AZs are specified, use commas (,) to separate AZ names. Take CN North-Beijing4 as an example. If three AZs are selected, the value of availability_zone is cn-north-4a,cn-north-4b,cn-north-4c. If a single AZ is used, the value of availability_zone is empty by default.
- NOTE: NOTE
- - If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.
- - If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ.
- - If the number of nodes is not a multiple of the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.
-
- |
-
-
-
-
-
- Table 5 CreateClusterInstanceVolumeBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-volume_type
- |
-Yes
- |
-String
- |
-Volume type
-
- |
-
-size
- |
-Yes
- |
-Integer
- |
-Volume size. The value must be greater than 0 and a multiple of 4 and 10. For details about the local disk size, see the diskrange attribute in Obtaining the Instance Specifications List. Unit: GB
- |
-
-
-
-
-
- Table 6 CreateClusterInstanceNicsBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-vpcId
- |
-Yes
- |
-String
- |
-VPC ID, which is used for configuring cluster network.
- |
-
-netId
- |
-Yes
- |
-String
- |
-Subnet ID (network ID).
- |
-
-securityGroupId
- |
-Yes
- |
-String
- |
-Security group ID.
- |
-
-
-
-
-
- Table 7 CreateClusterDatastoreBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-version
- |
-Yes
- |
-String
- |
-Elasticsearch/Logstash engine version. For details, see the supported versions in Before You Start.
- |
-
-type
- |
-Yes
- |
-String
- |
-Engine type. The value can be elasticsearch, logstash, or opensearch.
- |
-
-
-
-
-
- Table 8 CreateClusterBackupStrategyBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-period
- |
-Yes
- |
-String
- |
-Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.
- NOTE: The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.
-
- |
-
-prefix
- |
-Yes
- |
-String
- |
-Prefix of a snapshot that is automatically created, which is manually entered. Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
- |
-
-keepday
- |
-Yes
- |
-Integer
- |
-Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.
- |
-
-bucket
- |
-No
- |
-String
- |
-Name of the OBS bucket used for backup.
- |
-
-basePath
- |
-No
- |
-String
- |
-Storage path of the snapshot in the OBS bucket.
- |
-
-agency
- |
-No
- |
-String
- |
-IAM agency used to access OBS.
-If none of the bucket, basePath, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.
- |
-
-frequency
- |
-No
- |
-String
- |
-Frequency of automatically creating snapshots.
- NOTE: The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
-
- |
-
-
-
-
-
- Table 9 CreateClusterTagsBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-key
- |
-Yes
- |
-String
- |
-Separate multiple AZs with commas (,). For example, to specify three AZs in CN North-Beijing4, you can set availability_zone to cn-north-4a,cn-north-4b,cn-north-4c. By default, a single AZ is created when this parameter is not specified.
- |
-
-value
- |
-Yes
- |
-String
- |
-Tag value. The value can contain 0 to 43 characters. It can only contain digits, letters, hyphens (-), and underscores (_).
- |
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 10 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-cluster
- |
-CreateClusterClusterResponse object
- |
-Cluster object.
- |
-
-
-
-
-
- Table 11 CreateClusterClusterResponseParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Cluster ID.
- |
-
-name
- |
-String
- |
-Cluster name
- |
-
-
-
-
-
- Example RequestsExample request for creating a pay-per-use cluster.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters
-
-{
- "cluster" : {
- "instance" : {
- "flavorRef" : "ess.spec-4u16g",
- "volume" : {
- "volume_type" : "COMMON",
- "size" : 120
- },
- "nics" : {
- "vpcId" : "{VPC ID}",
- "netId" : "{NET ID}",
- "securityGroupId" : "{Security group ID}"
- },
- "availability_zone" : "{AZ CODE}"
- },
- "datastore" : {
- "version" : "{cluster-version}",
- "type" : "elasticsearch"
- },
- "name" : "cluster-name",
- "instanceNum" : 3,
- "backupStrategy" : {
- "period" : "16:00 GMT+08:00",
- "prefix" : "snapshot",
- "keepday" : 7,
- "frequency" : "DAY",
- "bucket" : "css-obs-backup",
- "basePath" : "css_repository/obs-path",
- "agency" : "css_obs_agency"
- },
- "httpsEnable" : true,
- "authorityEnable" : true,
- "adminPwd" : "{password}",
- "enterprise_project_id" : "0",
- "tags" : [ {
- "key" : "k1",
- "value" : "v1"
- }, {
- "key" : "k2",
- "value" : "v2"
- } ]
- }
-}
-
- Example ResponsesStatus code: 200
- Request succeeded.
- Example response for creating a pay-per-use cluster.
-{
- "cluster" : {
- "id" : "ef683016-871e-48bc-bf93-74a29d60d214",
- "name" : "ES-Test"
- }
-}
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Creating a Cluster (V2)
-FunctionThis API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, ess-master).
-
- URIPOST /v2.0/{project_id}/clusters
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-cluster
- |
-Yes
- |
-CreateClusterBody object
- |
-Cluster object.
- |
-
-
-
-
-
- Table 3 CreateClusterBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-name
- |
-Yes
- |
-String
- |
-Cluster name It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.
- |
-
-backupStrategy
- |
-No
- |
-CreateClusterBackupStrategyBody object
- |
-Automatic snapshot creation.
-The automatic snapshot creation policy is enabled only if backupStrategy is not left blank.
- |
-
-roles
- |
-Yes
- |
-Array of CreateClusterRolesBody objects
- |
-Cluster information
- |
-
-nics
- |
-Yes
- |
-CreateClusterInstanceNicsBody object
- |
-Subnet ID.
- |
-
-enterprise_project_id
- |
-No
- |
-String
- |
-Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
- |
-
-tags
- |
-No
- |
-Array of CreateClusterTagsBody objects
- |
-Cluster tag.
- |
-
-availability_zone
- |
-Yes
- |
-String
- |
-Availability zone (AZ). You need to specify the AZ name.
-By default, a single AZ is specified. If multiple AZs are specified, use commas (,) to separate AZ names. Take CN North-Beijing4 as an example. If three AZs are selected, the value of availability_zone is cn-north-4a,cn-north-4b,cn-north-4c. If a single AZ is used, the value of availability_zone is empty by default.
- NOTE: NOTE
- - If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.
- - If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ.
-
-
- |
-
-datastore
- |
-Yes
- |
-CreateClusterDatastoreBody object
- |
-Engine type. Its value can be elasticsearch, opensearch, or logstash.
- |
-
-authorityEnable
- |
-No
- |
-Boolean
- |
-Whether to enable authentication. The value can be true or false. Authentication is disabled by default.
-
-This parameter is supported in clusters 6.5.4 or later.
- |
-
-httpsEnable
- |
-No
- |
-Boolean
- |
-Whether communication is encrypted on the cluster. The value can be true or false. By default, communication encryption is disabled. When httpsEnable is set to true, authorityEnable must be set to true.- true: Communication is encrypted on the cluster.- false: Communication is not encrypted for the cluster.This parameter is supported in clusters 6.5.4 or later.
- |
-
-adminPwd
- |
-No
- |
-String
- |
-Password of the cluster user admin in security mode. This parameter is mandatory only when authorityEnable is set to true. Input requirements:
-Must contain 8 to 32 characters.
-Must contain at least three of the following character types: letters, digits, and special characters ~!@#$%^&*()-_=+\|[{}];:,<.>/?
-
- |
-
-publicIPReq
- |
-No
- |
-CreateClusterPublicIpReq object
- |
-Public network access information. This parameter is valid only when httpsEnable is set to true.
- |
-
-loadBalance
- |
-No
- |
-CreateClusterLoadBalance object
- |
-VPC endpoint service information
- |
-
-publicKibanaReq
- |
-No
- |
-CreateClusterPublicKibanaReq object
- |
-Kibana public network access information. This parameter is valid only when authorityEnable is set to true.
- |
-
-ipv6_enable
- |
-No
- |
-Boolean
- |
-Whether to enable automatic IPv6 address assignment for the cluster. The default value is false.
- |
-
-
-
-
-
- Table 4 CreateClusterBackupStrategyBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-period
- |
-Yes
- |
-String
- |
-Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.
- NOTE: The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.
-
- |
-
-frequency
- |
-No
- |
-String
- |
-Frequency of automatically creating snapshots.
- NOTE: The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
-
- |
-
-prefix
- |
-Yes
- |
-String
- |
-Prefix of a snapshot that is automatically created, which is manually entered. Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
- |
-
-keepday
- |
-Yes
- |
-Integer
- |
-Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.
- |
-
-bucket
- |
-No
- |
-String
- |
-Name of the OBS bucket used for backup.
- |
-
-basePath
- |
-No
- |
-String
- |
-Storage path of the snapshot in the OBS bucket.
- |
-
-agency
- |
-No
- |
-String
- |
-IAM agency used to access OBS.
-If none of the bucket, base_path, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.
- |
-
-
-
-
-
- Table 5 CreateClusterRolesBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-flavorRef
- |
-Yes
- |
-String
- |
-Instance flavor. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.
- |
-
-volume
- |
-Yes
- |
-CreateClusterInstanceVolumeBody object
- |
-Volume information. If flavorRef is set to a local disk flavor, leave this parameter blank. Obtain the the local disk flavor by referring to the diskrange attribute in Obtaining the Instance Specifications List. Currently, the following local disk flavors are supported:
-ess.spec-i3small
-ess.spec-i3medium
-ess.spec-i3.8xlarge.8
-ess.spec-ds.xlarge.8
-ess.spec-ds.2xlarge.8
-ess.spec-ds.4xlarge.8
-
- |
-
-type
- |
-Yes
- |
-String
- |
-ess-master indicates a master node.
-ess-client indicates a client node.
-ess-cold indicates a cold data node.
-ess indicates a data node.
-lgs indicates a Logstash node.
-[- chinese indicates a Chinese language model.
-english indicates an English language model.
-arabic indicates an Arabic model.
-thai indicates a Thai model.
-turkish indicates a Turkish language model.
-tools indicates a tools model.] (tag:white)
-
- |
-
-instanceNum
- |
-Yes
- |
-Integer
- |
-Number of instances.
-If ess is selected, you can set the value to 1 to 32.
-If both ess and ess-master are selected, you can set the value to 1 to 200.
-If both ess and ess-client are selected, you can set the value to 1 to 32.
-If both ess and ess-cold are selected, you can set the value to 32.
-
-If ess-master is selected, you can set the value to 3 to 10.
-If ess-client is selected, you can set the value to 1 to 32.
-If ess-cold is selected, you can set the value to 1 to 32.
-
- |
-
-
-
-
-
- Table 6 CreateClusterInstanceVolumeBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-volume_type
- |
-Yes
- |
-String
- |
-Volume type
-
- |
-
-size
- |
-Yes
- |
-Integer
- |
-Volume size. The value must be greater than 0 and a multiple of 4 and 10. Unit: GB
- |
-
-
-
-
-
- Table 7 CreateClusterInstanceNicsBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-vpcId
- |
-Yes
- |
-String
- |
-VPC ID, which is used for configuring cluster network.
- |
-
-netId
- |
-Yes
- |
-String
- |
-Subnet ID (network ID).
- |
-
-securityGroupId
- |
-Yes
- |
-String
- |
-Security group ID.
- |
-
-
-
-
-
- Table 8 CreateClusterTagsBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-key
- |
-Yes
- |
-String
- |
-Tag key. The value can contain 1 to 36 characters. It can only contain digits, letters, hyphens (-), and underscores (_).
- |
-
-value
- |
-Yes
- |
-String
- |
-Tag value. The value can contain 0 to 43 characters. It can only contain digits, letters, hyphens (-), and underscores (_).
- |
-
-
-
-
-
- Table 9 CreateClusterDatastoreBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-version
- |
-Yes
- |
-String
- |
-Version of the CSS cluster engine. For details, see the supported versions in Before You Start.
-[For a serverless cluster, logs, search, and vector are supported.] (tag:white)
- |
-
-type
- |
-Yes
- |
-String
- |
-Engine type. Its value can be elasticsearch, opensearch, or logstash.
-[For a serverless cluster, serverless-opensearch is used.] (tag:white)
- |
-
-
-
-
-
- Table 10 CreateClusterPublicIpReqParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-eip
- |
-Yes
- |
-CreateClusterPublicEip object
- |
-Public network bandwidth.
- |
-
-elbWhiteListReq
- |
-Yes
- |
-CreateClusterElbWhiteList object
- |
-EIP whitelist.
- |
-
-publicBindType
- |
-Yes
- |
-String
- |
-Whether to automatically bind an EIP. Specifies whether to automatically bind an EIP. Currently, only auto_assign is supported.
- |
-
-eipId
- |
-No
- |
-String
- |
-EIP ID.
- |
-
-
-
-
-
- Table 11 CreateClusterPublicEipParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-bandWidth
- |
-Yes
- |
-CreateClusterPublicEipSize object
- |
-Public network bandwidth.
- |
-
-
-
-
-
- Table 12 CreateClusterPublicEipSizeParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-size
- |
-Yes
- |
-Integer
- |
-Bandwidth range.
- |
-
-
-
-
-
- Table 13 CreateClusterElbWhiteListParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-enableWhiteList
- |
-Yes
- |
-Boolean
- |
-Whether to enable the public network access control.
- |
-
-whiteList
- |
-No
- |
-String
- |
-Public network access control whitelist. Separate the whitelisted network segments or IP addresses with commas (,), and each of them must be unique.
- |
-
-
-
-
-
- Table 14 CreateClusterLoadBalanceParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-endpointWithDnsName
- |
-Yes
- |
-Boolean
- |
-Whether to enable the private domain name.
-
- |
-
-vpcPermissions
- |
-No
- |
-Array of strings
- |
-Access control.
- |
-
-professionVpcep
- |
-No
- |
-Boolean
- |
-Create a professional VPC endpoint.
-true: enabled.
-false: disabled.
-
- |
-
-dualstackEnable
- |
-No
- |
-Boolean
- |
-Whether to enable the IPv4/IPv6 dual-stack network. The IPv4/IPv6 dual-stack network can be enabled only when a professional VPC endpoint is created and the VPC of the cluster supports IPv6.
-true: enabled.
-false: disabled.
-
- |
-
-
-
-
-
- Table 15 CreateClusterPublicKibanaReqParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-eipSize
- |
-Yes
- |
-Integer
- |
-Bandwidth range.
- |
-
-elbWhiteList
- |
-Yes
- |
-CreateClusterPublicKibanaElbWhiteList object
- |
-Kibana whitelist information.
- |
-
-
-
-
-
- Table 16 CreateClusterPublicKibanaElbWhiteListParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-whiteList
- |
-Yes
- |
-String
- |
-Whitelist. Separate the whitelisted network segments or IP addresses with commas (,), and each of them must be unique.
- |
-
-enableWhiteList
- |
-Yes
- |
-Boolean
- |
-Whether to enable the Kibana access control.
- |
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 17 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-cluster
- |
-CreateClusterResp object
- |
-Cluster object.
- |
-
-
-
-
-
- Table 18 CreateClusterRespParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Cluster ID.
- |
-
-name
- |
-String
- |
-Cluster name
- |
-
-
-
-
-
- Example RequestsExample request for creating a pay-per-use cluster.
- {
- "cluster" : {
- "name" : "css-cluster",
- "backupStrategy" : {
- "period" : "16:00 GMT+08:00",
- "prefix" : "snapshot",
- "keepday" : 7,
- "frequency" : "DAY",
- "bucket" : "OBS-obsName",
- "basePath" : "css_repository/obs-path",
- "agency" : "css_obs_agency"
- },
- "roles" : [ {
- "flavorRef" : "ess.spec-4u8g",
- "volume" : {
- "volume_type" : "COMMON",
- "size" : 100
- },
- "type" : "ess",
- "instanceNum" : 1
- } ],
- "nics" : {
- "vpcId" : "{VPC ID}",
- "netId" : "{NET ID}",
- "securityGroupId" : "{Security group ID}"
- },
- "enterprise_project_id" : 0,
- "tags" : [ {
- "key" : "k1",
- "value" : "v1"
- }, {
- "key" : "k2",
- "value" : "v2"
- } ],
- "availability_zone" : "{Az code}",
- "datastore" : {
- "version" : "{cluster-version}",
- "type" : "elasticsearch"
- },
- "authorityEnable" : true,
- "httpsEnable" : true,
- "adminPwd" : "{password}",
- "publicIPReq" : {
- "eip" : {
- "bandWidth" : {
- "size" : 5
- }
- },
- "elbWhiteListReq" : {
- "enableWhiteList" : true,
- "whiteList" : "127.0.0.1"
- },
- "publicBindType" : "auto_assign",
- "eipId" : null
- },
- "loadBalance" : {
- "endpointWithDnsName" : false,
- "vpcPermissions" : [ "{Account ID}" ]
- },
- "publicKibanaReq" : {
- "eipSize" : 5,
- "elbWhiteList" : {
- "whiteList" : "127.0.0.1",
- "enableWhiteList" : true
- }
- }
- }
-}
-
- Example ResponsesStatus code: 200
- Request succeeded.
- Example response for creating a pay-per-use cluster.
-{
- "cluster" : {
- "id" : "ef683016-871e-48bc-bf93-74a29d60d214",
- "name" : "ES-Test"
- }
-}
-Example response for creating a yearly/monthly cluster.
-{
- "orderId" : "CS2208241141LY94J",
- "cluster" : {
- "id" : "ef683016-871e-48bc-bf93-74a29d60d214",
- "name" : "ES-Test"
- }
-}
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Adding Tags to a Cluster
-FunctionThis API is used to add tags to a cluster.
-
-
- Request Parameters
-
-
-
-
- Response ParametersNone
-
- Example RequestsCreate a cluster tag.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags
-
-{
- "tag" : {
- "key" : "K1",
- "value" : "V1"
- }
-}
-
-
-
-
- Configuring the Elasticsearch Listener
-FunctionThis API is used to configure the Elasticsearch listener.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/es-listeners
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster that you want to rename.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-protocol
- |
-Yes
- |
-String
- |
-Protocol type. HTTP and HTTPS are supported.
- |
-
-protocol_port
- |
-Yes
- |
-Integer
- |
-Port
- |
-
-server_cert_id
- |
-No
- |
-String
- |
-Server certificate ID. This parameter is mandatory when protocol is set to HTTPS.
- |
-
-ca_cert_id
- |
-No
- |
-String
- |
-CA certificate ID. This parameter is mandatory when protocol is set to HTTPS and bidirectional authentication is used.
- |
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 3 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-elb_id
- |
-String
- |
-Load balancer ID
- |
-
-
-
-
-
- Example RequestsPOST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/es-listeners
-
-{
- "protocol" : "HTTPS",
- "protocol_port" : "9200",
- "server_cert_id" : "1b74ae4afad741e6bc9497429d3d0838",
- "ca_cert_id" : "2a7b050f598e4ea8a61cffbe2bdb312f"
-}
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "elb_id" : "56a83547-a55a-407a-8245-7f9b3a0606c0"
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request instead of retrying.
- |
-
-409
- |
-The request cannot be processed due to a conflict.
-This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
- |
-
-412
- |
-The server does not meet one of the requirements that the requester puts on the request.
- |
-
-
-
-
-
-
- Backing Up Logs
-FunctionThis API is used to back up logs.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/logs/collect
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster whose logs you want to back up.
- |
-
-
-
-
-
-
- Response ParametersNone
-
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Manually Creating a Snapshot
-FunctionThis API is used to manually create a snapshot.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster for which you want to create a snapshot.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-name
- |
-Yes
- |
-String
- |
-Snapshot name. Enter 4 to 64 characters. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.
- |
-
-description
- |
-No
- |
-String
- |
-Snapshot description. The value can contain up to 256 characters and cannot contain the following characters: !<>=&"'
- |
-
-indices
- |
-No
- |
-String
- |
-Name of an index to be backed up. Multiple indexes are separated by commas (,). By default, all indexes are backed up. You can use the combination of a backslash and an asterisk (*) to back up data of certain indexes. For example, if you specify 2018-06*, then the data of the indexes with the prefix 2018-06 will be backed up.The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?
- |
-
-
-
-
-
- Response ParametersStatus code: 201
-
- Table 3 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-backup
- |
-backupRsp object
- |
-Snapshot information.
- |
-
-
-
-
-
- Table 4 backupRspParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Snapshot ID
- |
-
-name
- |
-String
- |
-Snapshot name
- |
-
-
-
-
-
- Example RequestsCreate a snapshot.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot
-
-{
- "name" : "snapshot_001",
- "indices" : "myindex1myindex2"
-}
-
- Example ResponsesStatus code: 201
- Resource created.
- {
- "backup" : {
- "id" : "9dc4f5c9-33c0-45c7-9378-ae35ae350682",
- "name" : "snapshot_101"
- }
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-201
- |
-Resource created.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-403
- |
-Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
- |
-
-406
- |
-The server could not fulfill the request according to the content characteristics of the request.
- |
-
-500
- |
-The server has received the request but could not understand it.
- |
-
-501
- |
-The server does not support the function required to fulfill the request.
- |
-
-
-
-
-
-
- Deleting a Cluster
-FunctionThis API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluster, create a snapshot before deleting the cluster.
- This API can also be used to unsubscribe from clusters in yearly/monthly mode. Clusters frozen for public security cannot be deleted.
-
- URIDELETE /v1.0/{project_id}/clusters/{cluster_id}
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to delete.
- |
-
-
-
-
-
-
- Response ParametersNone
-
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-404
- |
-The requested resource could not be found.
-Modify the request before retry.
- |
-
-
-
-
-
-
- Deleting a Cluster Tag
-FunctionThis API is used to delete a cluster tag.
-
-
-
- Response ParametersNone
-
-
-
-
-
- Deleting a Snapshot
-FunctionThis API is used to delete a snapshot.
-
- URIDELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster whose snapshot you want to delete.
- |
-
-snapshot_id
- |
-Yes
- |
-String
- |
-ID of the snapshot you want to delete.
- |
-
-
-
-
-
-
- Response ParametersNone
-
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-403
- |
-Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
- |
-
-
-
-
-
-
- Downloading a Security Certificate
-FunctionThis API is used to download a security certificate.
-
- URIGET /v1.0/{project_id}/cer/download
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 2 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
--
- |
-File
- |
-File stream
- |
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- "Certificate:xxxx"
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-404
- |
-The requested resource could not be found.
-Modify the request before retry.
- |
-
-
-
-
-
-
- Enabling or Disabling the Elasticsearch Load Balancer
-FunctionThis API is used to enable or disable the Elasticsearch load balancer.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switch
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster to be modified
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-enable
- |
-Yes
- |
-Boolean
- |
-Enable or disable the ES load balancer.
-
- |
-
-agency
- |
-No
- |
-String
- |
-Agency name
- |
-
-elb_id
- |
-No
- |
-String
- |
-Load balancer ID
- |
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 3 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-elb_id
- |
-String
- |
-Load balancer ID
- |
-
-
-
-
-
- Example RequestsEnable the load balancer.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/loadbalancers/es-switch
-
-{
- "enable" : true,
- "elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
- "agency" : "css_elb_agency"
-}
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268"
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request instead of retrying.
- |
-
-409
- |
-The request cannot be processed due to a conflict.
-This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
- |
-
-412
- |
-The server does not meet one of the requirements that the requester puts on the request.
- |
-
-
-
-
-
-
- Querying the Cluster List
-FunctionThis API is used to query and display the cluster list and cluster status.
-
- URIGET /v1.0/{project_id}/clusters
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Parameter description:
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
-Constraints:
-N/A
-Options:
-Letters and digits
-Default value:
-N/A
- |
-
-
-
-
-
- Table 2 Query ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-start
- |
-No
- |
-Integer
- |
-Parameter description:
-The start value of the query. The default value is 1, indicating that the query starts from the first cluster.
-Constraints:
-N/A
-Options:
-1-1000
-Default value:
-1
- |
-
-limit
- |
-No
- |
-Integer
- |
-Parameter description:
-Number of clusters to be queried. The default value is 10, indicating that the information about 10 clusters is queried at a time.
-Constraints:
-N/A
-Options:
-1-1000
-Default value:
-10
- |
-
-datastoreType
- |
-No
- |
-String
- |
-Parameter description:
-Cluster engine type.
-Constraints:
-N/A
-Options:
-elasticsearch, logstash, or opensearch.
-Default value:
-elasticsearch.
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 3 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-totalSize
- |
-Integer
- |
-Number of clusters
- |
-
-clusters
- |
-Array of ClusterList objects
- |
-List of cluster objects.
- |
-
-
-
-
-
- Table 4 ClusterListParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-datastore
- |
-ClusterListDatastore object
- |
-Search engine.
- |
-
-instances
- |
-Array of ClusterListInstances objects
- |
-List of node objects.
- |
-
-publicKibanaResp
- |
-publicKibanaRespBody object
- |
-Kibana public network access information.
- |
-
-elbWhiteList
- |
-elbWhiteListResp object
- |
-EIP whitelist.
- |
-
-updated
- |
-String
- |
-Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
- |
-
-name
- |
-String
- |
-Cluster name
- |
-
-publicIp
- |
-String
- |
-Public IP address information.
- |
-
-created
- |
-String
- |
-Cluster creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
-The returned cluster list is sorted by creation time in descending order. The latest cluster is displayed at the top.
- |
-
-id
- |
-String
- |
-Cluster ID.
- |
-
-status
- |
-String
- |
-Cluster status.
-
- |
-
-endpoint
- |
-String
- |
-IPv4 address and port number accessed from the cluster's private network. [If the cluster type is KooSearch, this field indicates the internal address and port number for accessing the knowledge management service.] (tag:white)
- |
-
-vpcId
- |
-String
- |
-ID of a VPC.
- |
-
-subnetId
- |
-String
- |
-Subnet ID.
- |
-
-securityGroupId
- |
-String
- |
-Security group ID.
- |
-
-bandwidthSize
- |
-Integer
- |
-Public network bandwidth. Unit: Mbit/s
- |
-
-httpsEnable
- |
-Boolean
- |
-Communication encryption status.
-
- |
-
-authorityEnable
- |
-Boolean
- |
-Whether to enable authentication.
-
- |
-
-diskEncrypted
- |
-Boolean
- |
-Whether disks are encrypted.
-
- |
-
-backupAvailable
- |
-Boolean
- |
-Whether the snapshot function is enabled.
-
- |
-
-actionProgress
- |
-Object
- |
-Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage. CREATING indicates the progress of creation.
- |
-
-actions
- |
-Array of strings
- |
-Current behavior of a cluster. REBOOTING indicates that the cluster is being restarted. GROWING indicates that the cluster is being scaled. RESTORING indicates that the cluster is being restored. SNAPSHOTTING indicates that a snapshot is being created.
- |
-
-enterpriseProjectId
- |
-String
- |
-ID of the enterprise project that a cluster belongs to.
-If the user of the cluster does not enable the enterprise project, the setting of this parameter is not returned.
- |
-
-tags
- |
-Array of ClusterListTags objects
- |
-Cluster tag.
- |
-
-failedReason
- |
-ClusterListFailedReasons object
- |
-Failure cause. If the cluster is in the available status, this parameter is not returned.
- |
-
-bandwidthResourceId
- |
-String
- |
-ID of the resource accessed from the ES public network
- |
-
-ipv6Endpoint
- |
-String
- |
-IPv6 address and port number accessible from the cluster's private network.
- |
-
-
-
-
-
- Table 5 ClusterListDatastoreParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-type
- |
-String
- |
-Engine type. Its value can be elasticsearch or logstash.
- |
-
-version
- |
-String
- |
-Version of the CSS cluster engine. For details, see the supported versions in Before You Start.
- |
-
-supportSecuritymode
- |
-Boolean
- |
-Whether the security mode is supported.
- |
-
-subVersion
- |
-String
- |
-Cluster image version.
- |
-
-isEosCluster
- |
-Boolean
- |
-Whether the cluster image version has reached EOS. The value can be true or false.
- |
-
-
-
-
-
- Table 6 ClusterListInstancesParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-status
- |
-String
- |
-Node status.
-
- |
-
-type
- |
-String
- |
-Type of the current node.
- |
-
-id
- |
-String
- |
-Instance ID.
- |
-
-name
- |
-String
- |
-Instance name.
- |
-
-specCode
- |
-String
- |
-Node specifications.
- |
-
-azCode
- |
-String
- |
-AZ of a node.
- |
-
-ip
- |
-String
- |
-Instance IP address.
- |
-
-volume
- |
-ClusterVolumeRsp object
- |
-definitions.ClusterVolumeRsp.description
- |
-
-resourceId
- |
-String
- |
-ID of the instance resource
- |
-
-
-
-
-
- Table 7 ClusterVolumeRspParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-type
- |
-String
- |
-Type of the disk used by the instance.
- |
-
-size
- |
-Integer
- |
-Instance disk information
- |
-
-resourceIds
- |
-Array of strings
- |
-Instance disk resource ID
- |
-
-
-
-
-
- Table 8 publicKibanaRespBodyParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-eipSize
- |
-Integer
- |
-Bandwidth range. Unit: Mbit/s
- |
-
-elbWhiteListResp
- |
-kibanaElbWhiteListResp object
- |
-Kibana public network access information.
- |
-
-publicKibanaIp
- |
-String
- |
-Specifies the IP address for accessing Kibana.
- |
-
-bandwidthResourceId
- |
-String
- |
-Resource ID corresponding to the Kibana public network
- |
-
-
-
-
-
- Table 9 kibanaElbWhiteListRespParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-enableWhiteList
- |
-Boolean
- |
-Whether the Kibana access control is enabled.
-
- |
-
-whiteList
- |
-String
- |
-Whitelist of public network for accessing Kibana.
- |
-
-
-
-
-
- Table 10 elbWhiteListRespParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-enableWhiteList
- |
-Boolean
- |
-Whether the public network access control is enabled.
-
- |
-
-whiteList
- |
-String
- |
-Whitelist for public network access.
- |
-
-
-
-
-
-
-
- Table 12 ClusterListFailedReasonsParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-errorCode
- |
-String
- |
-Error code.
-CSS.6000: A cluster fails to be created.
-CSS.6001: A cluster fails to be scaled out.
-CSS.6002: A cluster fails to be restarted.
-CSS.6004: A node fails to be created in a cluster.
-CSS.6005: A service fails to be initialized.
-
- |
-
-errorMsg
- |
-String
- |
-Error details.
- |
-
-
-
-
-
- Example RequestsQuery the first two clusters.
-- Method 1: GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=2
-- Method 2: GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=2
-Query the first ten clusters.
-- Method 1: GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=10
-- Method 2: GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=10
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "totalSize" : 1,
- "clusters" : [ {
- "datastore" : {
- "type" : "elasticsearch",
- "version" : "7.10.2",
- "subVersion" : "7.10.2_24.3.0_0827",
- "isEosCluster" : false,
- "supportSecuritymode" : false
- },
- "instances" : [ {
- "status" : "200",
- "type" : "ess",
- "id" : "{INSTANCE_ID}",
- "name" : "css-8bc5-ess-esn-1-1",
- "specCode" : "ess.spec-4u8g",
- "azCode" : "{AZ_CODE}",
- "volume" : {
- "type" : "ULTRAHIGH",
- "size" : 40,
- "resourceIds" : [ "{RESOURCE_ID}" ]
- },
- "ip" : "192.168.0.122",
- "resourceId" : "{RESOURCE_ID}"
- } ],
- "publicKibanaResp" : {
- "eipSize" : 10,
- "publicKibanaIp" : "100.95.152.28:9200",
- "elbWhiteListResp" : null,
- "bandwidthResourceId" : "18bec13f-5cc1-4631-867f-33505d15be12"
- },
- "elbWhiteList" : {
- "whiteList" : "",
- "enableWhiteList" : false
- },
- "updated" : "2023-10-09T02:07:13",
- "name" : "css-8bc5",
- "publicIp" : "100.85.222.202",
- "created" : "2023-10-09T02:07:13",
- "id" : "{CLUSTER_ID}",
- "status" : "200",
- "endpoint" : "192.168.0.122:9200",
- "vpcId" : "{VPC_ID}",
- "subnetId" : "{SUBNET_ID}",
- "securityGroupId" : "{SECURITY_GROUP_ID}",
- "bandwidthResourceId" : "{BANDWIDTH_RESOURCE_ID}",
- "bandwidthSize" : 3,
- "httpsEnable" : true,
- "authorityEnable" : true,
- "diskEncrypted" : false,
- "backupAvailable" : false,
- "actionProgress" : { },
- "actions" : [ ],
- "enterpriseProjectId" : "0",
- "tags" : [ ],
- "period" : true
- } ]
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-404
- |
-The requested resource could not be found.
-Modify the request before retry.
- |
-
-
-
-
-
-
- Querying All Tags
-FunctionThis API is used to query all tags in a specified region.
-
-
-
- Response ParametersStatus code: 200
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "tags" : [ {
- "key" : "key1",
- "values" : [ "value1", "value2" ]
- }, {
- "key" : "key2",
- "values" : [ "value1", "value2" ]
- } ]
-}
-
-
-
- Querying the Certificate List
-FunctionThis API is used to query the certificate list.
-
- URIGET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificates
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to query
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 2 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-certificates
- |
-CertificatesResource object
- |
-Certificate list information
- |
-
-
-
-
-
- Table 3 CertificatesResourceParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Certificate ID
- |
-
-name
- |
-String
- |
-Certificate name
- |
-
-type
- |
-String
- |
-Type of the SL certificate. The value can be server or client. server indicates server certificates, and client indicates CA certificates.
- |
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "certificates" : [ {
- "id" : "8c415d2e2f4c4fdbbfc9c21c98d7832b",
- "name" : "server1",
- "type" : "server"
- }, {
- "id" : "8c415d2e2f4c4fdbbfc9c21c98d7832b",
- "name" : "ca1",
- "type" : "client"
- }, {
- "id" : "8c415d2e2f4c4fdbbfc9c21c98d7832b",
- "name" : "server-css",
- "type" : "server"
- } ]
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request instead of retrying.
- |
-
-409
- |
-The request cannot be processed due to a conflict.
-This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
- |
-
-412
- |
-The server does not meet one of the requirements that the requester puts on the request.
- |
-
-
-
-
-
-
- Querying ELBv3 Load Balancers Supported by a Cluster
-FunctionThis API is used to query the ELBv3 load balancers supported by a cluster.
-
- URIGET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to query.
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 2 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-loadbalancers
- |
-Array of LoadbalancersResource objects
- |
-Load balancer list
- |
-
-
-
-
-
- Table 3 LoadbalancersResourceParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Load balancer ID
- |
-
-name
- |
-String
- |
-Load balancer name
- |
-
-l7_flavor_id
- |
-String
- |
-Layer 7 protocol ID
- |
-
-ip_target_enable
- |
-Boolean
- |
-Indicates whether to enable the cross-VPC backend.
- |
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "loadbalancers" : [ {
- "id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
- "name" : "elb-css",
- "l7_flavor_id" : "9c8c2425-e061-4bf8-ac65-cd1db92b18e1",
- "ip_target_enable" : true
- }, {
- "id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6269",
- "name" : "elb-b832",
- "l7_flavor_id" : "9c8c2425-e061-4bf8-ac65-cd1db92b18e1",
- "ip_target_enable" : true
- } ]
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request instead of retrying.
- |
-
-409
- |
-The request cannot be processed due to a conflict.
-This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
- |
-
-412
- |
-The server does not meet one of the requirements that the requester puts on the request.
- |
-
-
-
-
-
-
- Obtaining the Instance Specifications List
-FunctionThis API is used to query and display the IDs of supported instance specifications.
+ Obtaining the List of Instance Flavors
+ FunctionThis API is used to query and display the IDs of supported instance flavors.
- URIGET /v1.0/{project_id}/es-flavors
+ URIGET /v1.0/{project_id}/flavors
- Table 1 Path ParametersParameter
+Table 1 Parameter descriptionParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Project ID. For details, see Obtaining a Project ID and Name.
|
Request ParametersNone
+
- Response ParametersStatus code: 200
+ ResponseTable 2 describes the response parameters.
- Table 2 Response body parametersParameter
+Table 2 Parameter descriptionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-versions
+ | versions
|
-Array of EsflavorsVersionsResp objects
+ | Array of versions objects
|
-Engine version list.
+ | List of engine versions.
|
Table 3 EsflavorsVersionsRespParameter
+Table 3 versions field descriptionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-version
+ | version
|
-String
+ | String
|
-Elasticsearch engine version. For details, see the supported versions in Before You Start.
+ | Engine version.
|
-flavors
+ | type
|
-Array of EsflavorsVersionsFlavorsResp objects
+ | String
|
-instance flavor list.
+ | Instance type. The options are ess, ess-cold, ess-master, and ess-client.
|
-type
+ | flavors
|
-String
+ | Array of flavors objects
|
-Instance type. The options are ess, ess-cold, ess-master, and ess-client.
+ | Flavor list
|
Table 4 EsflavorsVersionsFlavorsRespParameter
+Table 4 flavors field descriptionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-cpu
+ | ram
|
-Integer
+ | Integer
|
-Number of CPU cores of an instance.
+ | Memory size of an instance. Unit: GB
|
-ram
+ | cpu
|
-Integer
+ | Integer
|
-Memory size of an instance. Unit: GB
+ | Number of vCPUs of an instance.
|
-name
+ | name
|
-String
+ | String
|
-Flavor name
+ | Flavor name.
|
-region
+ | region
|
-String
+ | String
|
-Available region
+ | AZ
|
-diskrange
+ | diskrange
|
-String
+ | String
|
-Disk capacity range of an instance
+ | Disk capacity range of an instance.
|
-availableAZ
+ | flavor_id
|
-String
+ | String
|
-AZ
- |
-
-flavor_id
- |
-String
- |
-Flavor ID
+ | ID of a flavor.
|
Example RequestsNone
+ ExamplesExample request GET /v1.0/6204a5bd270343b5885144cf9c8c158d/flavors
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "versions" : [ {
- "flavors" : [ {
- "cpu" : 4,
- "ram" : 32,
- "name" : "ess.spec-4u32g",
- "region" : "xx-xxx-xx",
- "diskrange" : "40,2560",
- "availableAZ" : "xx-xxx-xx,xx-xxx-xx",
- "flavor_id" : "2d8daf1b-873f-4c2e-a7b9-2f9cbcf2f213"
- }, {
- "cpu" : 8,
- "ram" : 64,
- "name" : "ess.spec-8u64g",
- "region" : "xx-xxx-xx",
- "diskrange" : "80,5120",
- "availableAZ" : "xx-xxx-xx,xx-xxx-xx",
- "flavor_id" : "b3d33ec6-d58a-40f0-aa51-4f671ce64b2a"
- }, {
- "cpu" : 16,
- "ram" : 128,
- "name" : "ess.spec-16u128g",
- "region" : "xx-xxx-xx",
- "diskrange" : "160,10240",
- "availableAZ" : "xx-xxx-xx,xx-xxx-xx",
- "flavor_id" : "f74419ca-bc91-4558-b4e2-90eeefb37c6e"
- } ],
- "type" : "ess",
- "version" : "x.x.x"
- } ]
+Example response
+{
+ "versions": [
+ {
+ "version": "6.2.3",
+ "flavors": [
+ {
+ "cpu": 1,
+ "ram": 8,
+ "name": "css.medium.8",
+ "region": "eu-de",
+ "diskrange": "40,640",
+ "flavor_id": "6b6c0bcf-750d-4f8a-b6f5-c45a143f5198"
+
+ },
+ {
+ "cpu": 2,
+ "ram": 16,
+ "name": "css.large.8",
+ "region": "eu-de",
+ "diskrange": "40,1280",
+ "flavor_id": "d373e339-3cf4-4c00-9739-2259e9f3ec16"
+
+ },
+ {
+ "cpu": 4,
+ "ram": 32,
+ "name": "css.xlarge.8",
+ "region": "eu-de",
+ "diskrange": "40,2560",
+ "flavor_id": "2d8daf1b-873f-4c2e-a7b9-2f9cbcf2f213"
+
+ },
+ {
+ "cpu": 8,
+ "ram": 64,
+ "name": "css.2xlarge.8",
+ "region": "eu-de",
+ "diskrange": "80,5120",
+ "flavor_id": "b3d33ec6-d58a-40f0-aa51-4f671ce64b2a"
+
+ },
+ {
+ "cpu": 16,
+ "ram": 128,
+ "name": "css.4xlarge.8",
+ "region": "eu-de",
+ "diskrange": "160,10240",
+ "flavor_id": "f74419ca-bc91-4558-b4e2-90eeefb37c6e"
+ }
+ ]
+ }
+ ]
}
- Status Codes
- Status Code
+Status CodeTable 5 describes the status code.
+
+ Table 5 Status codesStatus Code
|
-Description
+ | Message
+ |
+Description
|
|---|
-200
+ | 400
|
-Request succeeded.
+ | BadRequest
+ |
+Invalid request.
+Modify the request instead of retrying.
|
-400
+ | 404
|
-Invalid request.
-Modify the request before retry.
+ | NotFound
+ |
+The requested resource cannot be found.
+Modify the request instead of retrying.
|
-404
+ | 200
|
-The requested resource could not be found.
-Modify the request before retry.
+ | OK
+ |
+The request is processed.
|
Obtaining a Target Image ID
-FunctionThis API is used to obtain the ID of an image that can be upgraded in the current cluster.
+ FunctionThis API is used to obtain the ID of an image that can be upgraded in the current cluster.
- URIGET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images
+
+ URIGET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images
- Table 1 Path ParametersParameter
+Table 1 Path parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.
|
-cluster_id
+ | cluster_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-ID of the cluster to be upgraded.
+ | ID of the cluster to be upgraded.
|
-upgrade_type
+ | upgrade_type
|
-Yes
+ | Yes
|
-String
+ | String
|
-Version type:
-same: upgrade to the same version.
-cross: upgrade to a different version.
-cross-engine: cross-engine upgrade.
-
+ | Version type. The value can be:
+- same: upgrade to the same version.
- cross: upgrade to a different version.
- crossEngine: cross-engine upgrade.
|
Request ParametersNone
+
- Response ParametersStatus code: 200
+ Response ParametersStatus code: 200
- Table 2 Response body parametersParameter
+Table 2 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-needUploadUpgradePlugin
+ | needUploadUpgradePlugin
|
-Boolean
+ | Boolean
|
-Whether to upload the plug-in of the target version.
+ | Indicates whether to upload the plug-in of the target version.
|
-imageInfoList
+ | imageInfoList
|
-Array of GetTargetImageIdDetail objects
+ | Array of GetTargetImageIdDetail objects
|
-Image details.
+ | Image details.
|
Table 3 GetTargetImageIdDetailParameter
+Table 3 GetTargetImageIdDetailParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-ID of an image that can be upgraded.
+ | ID of an image that can be upgraded.
|
-displayName
+ | displayName
|
-String
+ | String
|
-Name of an image that can be upgraded.
+ | Name of an image that can be upgraded.
|
-imageDesc
+ | imageDesc
|
-String
+ | String
|
-Image description.
+ | Image description.
|
-datastoreType
+ | datastoreType
|
-String
+ | String
|
-Image engine type.
+ | Image engine type.
|
-datastoreVersion
+ | datastoreVersion
|
-String
+ | String
|
-Image engine version.
+ | Image engine version.
|
-priority
+ | priority
|
-Integer
+ | Integer
|
-Priority.
+ | Priority
|
Example RequestsGET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images
+Request ExampleGET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images
{
"needUploadUpgradePlugin" : false,
"imageInfoList" : [ ]
}
Example ResponsesStatus code: 200
- Request succeeded.
- {
+Response ExampleStatus code: 200
+ The request is processed.
+ {
"needUploadUpgradePlugin" : false,
"imageInfoList" : [ ]
}
Status Codes
- Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | The request is processed.
|
-400
+ | 400
|
-Invalid request.
-The client should not repeat the request without modifications.
+ | Invalid request. Modify the request directly and do not attempt to retry it.
|
-403
+ | 403
|
-Request rejected.
-The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.
+ | The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it.
|
Querying the Job List
-FunctionThis API is used to query the job list in the logs of a cluster.
-
- URIGET /v1.0/{project_id}/clusters/{cluster_id}/logs/records
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to query.
- |
-
-
-
-
-
- Table 2 Query ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-start
- |
-No
- |
-Integer
- |
-The start value of the query. The default value is 1, indicating that the query starts from the first task.
- |
-
-limit
- |
-No
- |
-Integer
- |
-Number of task to be queried. The default value is 10, indicating that the information about 10 tasks is queried at a time.
- |
-
-status
- |
-No
- |
-String
- |
-Specifies the status of the log task to be queried. If this parameter is not set, all log tasks of the cluster are queried.
-FAIL: failed tasks
-NOT_FAIL: ongoing or successful tasks
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 3 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-clusterLogRecord
- |
-Array of clusterLogRecord objects
- |
-Cluster log entity object.
- |
-
-
-
-
-
- Table 4 clusterLogRecordParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Log task ID, which is generated based on the system UUID.
- |
-
-clusterId
- |
-String
- |
-Cluster ID.
- |
-
-createAt
- |
-String
- |
-Creation time. Format: Unix timestamp.
- |
-
-logPath
- |
-String
- |
-Storage path of backed up logs in the OBS bucket.
- |
-
-status
- |
-String
- |
-Task status
-
- |
-
-finishedAt
- |
-Long
- |
-End time. If the creation has not been completed, the end time is null. Format: Unix timestamp.
- |
-
-jobTypes
- |
-String
- |
-Task type.
-Manual: Manual backup.
-Auto: Automatic backup.
-
- |
-
-failedMsg
- |
-String
- |
-Error information. If the task did not fail, the value of this parameter is null.
- |
-
-jobId
- |
-String
- |
-Task ID.
- |
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "clusterLogRecord" : [ {
- "id" : "d455a541-597e-4846-a6be-baad0ea361b1",
- "clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
- "createAt" : 1656042837000,
- "logPath" : "css-backup-1610678043608/css/log",
- "status" : "RUNNING",
- "finishedAt" : null,
- "jobTypes" : "Manual",
- "failedMsg" : null,
- "jobId" : "2c9080df7c171342017c5e0884f8011c"
- } ]
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Querying a Snapshot List
-FunctionThis API is used to query all the snapshots of a cluster.
-
- URIGET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster whose snapshots you want to query.
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 2 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-backups
- |
-Array of ListSnapshotBackupsResp objects
- |
-Snapshot list
- |
-
-
-
-
-
- Table 3 ListSnapshotBackupsRespParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-created
- |
-String
- |
-Snapshot creation time
- |
-
-datastore
- |
-ListSnapshotBackupsDatastoreResp object
- |
-Search engine
- |
-
-description
- |
-String
- |
-Snapshot description
- |
-
-id
- |
-String
- |
-Snapshot ID
- |
-
-clusterId
- |
-String
- |
-Cluster ID
- |
-
-clusterName
- |
-String
- |
-Cluster name
- |
-
-name
- |
-String
- |
-Snapshot name
- |
-
-status
- |
-String
- |
-Snapshot status
- |
-
-updated
- |
-String
- |
-Time when the snapshot was updated. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
- |
-
-backupType
- |
-String
- |
-Snapshot creation type. The options are as follows:
-0: Automatic creation.
-1: Manual creation.
-
- |
-
-backupMethod
- |
-String
- |
-Snapshot creation mode
- |
-
-backupExpectedStartTime
- |
-String
- |
-Snapshot start time
- |
-
-backupKeepDay
- |
-Integer
- |
-Snapshot retention period
- |
-
-backupPeriod
- |
-String
- |
-Time when a snapshot is created every day
- |
-
-indices
- |
-String
- |
-Index you want to back up
- |
-
-totalShards
- |
-Integer
- |
-Total number of shards of the index you want to back up
- |
-
-failedShards
- |
-Integer
- |
-Number of shards that fail to be backed up
- |
-
-version
- |
-String
- |
-Snapshot version
- |
-
-restoreStatus
- |
-String
- |
-Snapshot restoration status
- |
-
-startTime
- |
-Long
- |
-Snapshot start timestamp
- |
-
-endTime
- |
-Long
- |
-Snapshot end timestamp
- |
-
-bucketName
- |
-String
- |
-Name of the bucket that stores snapshot data
- |
-
-
-
-
-
- Table 4 ListSnapshotBackupsDatastoreRespParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-type
- |
-String
- |
-Engine type. Currently, only Elasticsearch is supported.
- |
-
-version
- |
-String
- |
-Elasticsearch engine version. For details, see the supported versions in Before You Start.
- |
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "backups" : [ {
- "created" : "2018-03-07T07:34:47",
- "datastore" : {
- "type" : "elasticsearch",
- "version" : "x.x.x"
- },
- "description" : "",
- "id" : "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9",
- "clusterId" : "37cb1075-c38e-4cd8-81df-442d52df3786",
- "clusterName" : "Es-xfx",
- "name" : "snapshot-002",
- "status" : "COMPLETED",
- "updated" : "2018-03-07T07:40:12",
- "backupType" : "1",
- "backupMethod" : "manual",
- "backupExpectedStartTime" : null,
- "backupKeepDay" : null,
- "backupPeriod" : null,
- "indices" : ".kibanawebsite2",
- "totalShards" : 6,
- "failedShards" : 0,
- "version" : "x.x.x",
- "restoreStatus" : "success",
- "startTime" : 1520408087099,
- "endTime" : 1520408412219,
- "bucketName" : "obs-b8ed"
- }, {
- "created" : "2018-03-06T15:42:37",
- "datastore" : {
- "type" : "elasticsearch",
- "version" : "x.x.x"
- },
- "description" : "",
- "id" : "29a2254e-947f-4463-b65a-5f0b17515fae",
- "clusterId" : "37cb1075-c38e-4cd8-81df-442d52df3786",
- "clusterName" : "Es-xfx",
- "name" : "snapshot-001",
- "status" : "COMPLETED",
- "updated" : "2018-03-06T15:48:04",
- "backupType" : "1",
- "backupMethod" : "manual",
- "backupExpectedStartTime" : null,
- "backupKeepDay" : null,
- "backupPeriod" : null,
- "indices" : ".kibana",
- "totalShards" : 1,
- "failedShards" : 0,
- "version" : "x.x.x",
- "restoreStatus" : "none",
- "startTime" : 1520350957275,
- "endTime" : 1520351284357,
- "bucketName" : "obs-b8ed"
- } ]
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-406
- |
-The server could not fulfill the request according to the content characteristics of the request.
- |
-
-
-
-
-
-
- Obtaining the Parameter Configuration List
-FunctionThis API is used to obtain the parameter configuration list of the current cluster.
-
- URIGET /v1.0/{project_id}/clusters/{cluster_id}/ymls/template
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to query.
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 2 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-configurations
- |
-Object
- |
-Cluster parameter configuration list. The key value in the object is subject to the actual situation. The value has the following attributes:
-id: parameter ID.
-key: parameter name.
-value: parameter value.
-defaultValue: parameter default value.
-regex: parameter constraint.
-desc: parameter description.
-type: parameter type description.
-moduleDesc: parameter function description.
-modifyEnable: whether a parameter can be modified. true: The value can be changed. false: The value cannot be changed.
-enableValue: parameter value that can be changed.
-fileName: name of the file where parameters exist. The default value is elasticsearch.yml.
-version: version information.
-descENG: parameter description.
-moduleDescENG: parameter function description.
-
- |
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "configurations" : {
- "http.cors.allow-credentials" : {
- "id" : "b462d13c-294b-4e0f-91d3-58be2ad02b99",
- "key" : "http.cors.allow-credentials",
- "value" : "false",
- "defaultValue" : "false",
- "regex" : "^(true|false)$",
- "desc" : "Indicates whether to return **Access-Control-Allow-Credentials** in the header during cross-domain access. The value is of the Boolean type and can be **true** or **false**.",
- "type" : "Boolean",
- "moduleDesc" : "Cross-domain access",
- "modifyEnable" : "true",
- "enableValue" : "true,false",
- "fileName" : "elasticsearch.yml",
- "version" : null,
- "descENG" : "Whether to return the Access-Control-Allow-Credentials of the header during cross-domain access. The value is a Boolean value and the options are true and false.",
- "moduleDescENG" : "Cross-domain Access"
- }
- }
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Obtaining the Task List of Parameter Configurations
-FunctionThis API is used to obtain the parameter configuration task list of a cluster.
-
- URIGET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to query.
- |
-
-
-
-
-
- Table 2 Query ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-start
- |
-No
- |
-Integer
- |
-The start value of the query. The default value is 1, indicating that the query starts from the first task.
- |
-
-limit
- |
-No
- |
-Integer
- |
-Number of task to be queried. The default value is 10, indicating that the information about 10 tasks is queried at a time.
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 3 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-configList
- |
-Array of configListRsp objects
- |
-List of historical configuration changes
- |
-
-
-
-
-
- Table 4 configListRspParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Operation ID.
- |
-
-clusterId
- |
-String
- |
-Cluster ID.
- |
-
-createAt
- |
-String
- |
-Creation time. Format: Unix timestamp.
- |
-
-status
- |
-String
- |
-Task execution status.
-
- |
-
-finishedAt
- |
-String
- |
-End time. If the creation has not been completed, the end time is null. Format: Unix timestamp.
- |
-
-modifyDeleteReset
- |
-String
- |
-History of parameter setting modifications.
- |
-
-failedMsg
- |
-String
- |
-Returned error message. If the status is success, the value of this parameter is null.
- |
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "configList" : [ {
- "id" : "7ed7258a-60a8-46fe-8814-52819d491b80",
- "clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
- "createAt" : 1633658735000,
- "status" : "success",
- "finishedAt" : null,
- "modifyDeleteReset" : "{\"modify\":{\"elasticsearch.yml\":{\"thread_pool.force_merge.size\":\"1\"}}}",
- "failedMsg" : ""
- } ]
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Changing the Password of a Cluster
-FunctionThis API is used to change the password of a cluster.
+ Changing a Password
+ FunctionThis API is used to change the password of a cluster.
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/password/reset
+
+ URIPOST /v1.0/{project_id}/clusters/{cluster_id}/password/reset
- Table 1 Path ParametersParameter
+Table 1 Path parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.
|
-cluster_id
+ | cluster_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-ID of the cluster whose password you want to change.
+ | ID of the cluster whose password you want to change.
|
Request Parameters
- Table 2 Request body parametersParameter
+Request Parameters
+ Table 2 Request body parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-newpassword
+ | newpassword
|
-Yes
+ | Yes
|
-String
+ | String
|
-Password of the cluster user admin in security mode. This API is available only if authorityEnable is set to true.
-Must contain 8 to 32 characters.
-Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^&*()-_=+\|[{}];:,<.>/?).
-
+ | Password of the cluster user admin in security mode. This API is available only when authorityEnable is set to true.
+- The value can contain 8 to 32 characters.
- The value must contain at least 3 of the following character types: uppercase letters, lowercase letters, numbers, and special characters ~!@#$%&*()-_=|[{}];:,<.>/?
|
Response ParametersNone
+
- Example RequestsChange the administrator password of the current cluster.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/password/reset
+Request ExampleChange the administrator password of the current cluster.
+ POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/password/reset
{
"newpassword" : "xxxxxx"
}
Example ResponsesNone
+
- Status Codes
- Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | The request is processed.
|
-400
+ | 400
|
-Invalid request.
-Modify the request before retry.
+ | Invalid request.
+Modify the request instead of retrying.
|
-409
+ | 409
|
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
+ | The request cannot be processed due to a conflict.
+This status code indicates that the resource the client is attempting to create already exists, or that the update operation requested cannot be completed due to a conflict.
|
-412
+ | 412
|
-The server did not meet one of the preconditions contained in the request.
+ | The server did not satisfy one of the preconditions set by the requester in the request.
|
Restarting a Cluster
-FunctionThis API is used to restart a cluster. Services will be interrupted during the restart.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/restart
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to restart.
- |
-
-
-
-
-
-
- Response ParametersNone
-
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-404
- |
-The requested resource could not be found.
-Modify the request before retry.
- |
-
-
-
-
-
-
- Restarting a Cluster (V2)
-FunctionThis API is used to restart nodes of all node types or the combination of some node types in the current cluster.
-
- URIPOST /v2.0/{project_id}/clusters/{cluster_id}/restart
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to restart.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-type
- |
-Yes
- |
-String
- |
-Operation role. Value range:
-
- |
-
-value
- |
-Yes
- |
-String
- |
-Operation parameter. Parameter description:
-If the operation role is node, the value is the node ID. You can obtain the ID attribute in instances by referring to Querying Cluster Details.
-If the operation role is role, the value is one or multiple node types (such as ess, ess-master, ess-client, and ess-cold).
-
- |
-
-
-
-
-
- Response ParametersNone
-
- Example RequestsRestart nodes of all or some types in the current cluster.
- POST /v2.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/restart
-
-{
- "type" : "role",
- "value" : "ess"
-}
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Restoring a Snapshot
-FunctionThis API is used to manually restore a snapshot.
-
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restore
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster whose snapshot you want to restore.
- |
-
-snapshot_id
- |
-Yes
- |
-String
- |
-Snapshot ID.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-targetCluster
- |
-Yes
- |
-String
- |
-ID of the cluster that a snapshot is to be restored to.
- |
-
-indices
- |
-No
- |
-String
- |
-Name of an index to be restored. Multiple indexes are separated by commas (,). By default, all indexes are restored. You can use the combination of a backslash and an asterisk (*) to back up data of certain indexes. For example, if you specify 2018-06*, then the data of the indexes with the prefix 2018-06 will be restored.The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?
- |
-
-renamePattern
- |
-No
- |
-String
- |
-Rule for defining the indexes to be restored. The value contains a maximum of 1,024 characters. Indexes that match this rule will be restored. The filtering condition must be a regular expression.
-The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?
-This parameter takes effect only when both renameReplacement and renamePattern are set.
- |
-
-renameReplacement
- |
-No
- |
-String
- |
-Rule for renaming an index. The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/? For example, restored_index_$1 indicates adding the restored_ prefix to the names of all the restored indexes.The renamePattern and renameReplacement parameters must be set at the same time in order for them to take effect.
- |
-
-replace_exist_indices
- |
-No
- |
-Boolean
- |
-Replacing an existing index.
- |
-
-
-
-
-
- Response ParametersNone
-
- Example RequestsRestore a snapshot.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/653c086f-ebe7-4383-b902-c031b354f1dd/restore
-
-{
- "targetCluster" : "ea244205-d641-45d9-9dcb-ab2236bcd07e",
- "indices" : "myindex1,myindex2",
- "renamePattern" : "index",
- "renameReplacement" : "restored_index_$1"
-}
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-201
- |
-Resource created.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-403
- |
-Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
- |
-
-
-
-
-
-
- Retrying a Failed Upgrade Task
-FunctionThe upgrade may fail due to network problems. In this case, you can call this API to retry.
+ FunctionThe upgrade takes a long time and the upgrade may fail due to network problems. You can use this API to retry a task or terminate the impact of a task.
- URIPUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retry
+
+ URIPUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retry
- Table 1 Path ParametersParameter
+Table 1 Path parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.
|
-cluster_id
+ | cluster_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-ID of the cluster to retry upgrade.
+ | ID of the cluster to be retried.
|
-action_id
+ | action_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-ID of the task to be retried.
+ | ID of the task to be retried.
|
Table 2 Query ParametersParameter
+Table 2 Query parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-retry_mode
+ | retry_mode
|
-No
+ | No
|
-String
+ | String
|
-Impact of terminating the task. Currently, its value can only be abort.
+ | If this parameter is not left blank, the impact of the task is terminated. Currently, only abort is supported.
|
Request ParametersNone
+
- Response ParametersNone
+
- Example RequestsExample of an upgrade task retry request.
-PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry
-Example of an upgrade task termination request.
-PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry?retry_mode=abort
+Request Example- Example request for retrying an upgrade task.
PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry
+ - Example request for terminating an upgrade task.
PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry?retry_mode=abort
Example ResponsesNone
+
- Status Codes
- Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | The request is processed.
|
-400
+ | 400
|
-Invalid request.
-The client should not repeat the request without modifications.
+ | Invalid request. Modify the request directly and do not attempt to retry it.
|
-403
+ | 403
|
-Request rejected.
-The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.
+ | The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it.
|
Rolling Restart
-FunctionThis API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.
-
- URIPOST /v2.0/{project_id}/clusters/{cluster_id}/rolling_restart
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster you want to restart.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-type
- |
-Yes
- |
-String
- |
-Operation role. Its type can only be role.
- |
-
-value
- |
-Yes
- |
-String
- |
-Instance type. (At least one data node is required when you configure instance types.) Use commas (,) to separate multiple types. For example:
-ess-master indicates a master node.
-ess-client indicates a client node.
-ess-cold indicates a cold data node.
-ess indicates a data node.
-all indicates all nodes.
-
- |
-
-
-
-
-
- Response ParametersNone
-
- Example RequestsRestart a node.
- POST /v2.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/rolling_restart
-
-{
- "type" : "role",
- "value" : "ess"
-}
-
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-400
- |
-Invalid request.
-Modify the request before retry.
- |
-
-409
- |
-The request could not be completed due to a conflict with the current state of the resource.
-The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
- |
-
-412
- |
-The server did not meet one of the preconditions contained in the request.
- |
-
-
-
-
-
-
- Querying the Automatic Snapshot Creation Policy
-FunctionThis API is used to query the automatic snapshot creation policy.
-
- URIGET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
-
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster where snapshots are to be automatically created.
- |
-
-
-
-
-
-
- Response ParametersStatus code: 200
-
- Table 2 Response body parametersParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-keepday
- |
-Integer
- |
-Customize the number of snapshots to be retained.
- |
-
-period
- |
-String
- |
-Time when a snapshot is created every day.
- |
-
-prefix
- |
-String
- |
-Snapshot name prefix, which needs to be manually entered.
- |
-
-bucket
- |
-String
- |
-Name of the OBS bucket where snapshots are stored.
- |
-
-basePath
- |
-String
- |
-Storage path of the snapshot in the OBS bucket.
- |
-
-agency
- |
-String
- |
-Agency used to access OBS buckets.
- |
-
-enable
- |
-String
- |
-Whether to enable the automatic snapshot creation policy.
-
- |
-
-frequency
- |
-String
- |
-Frequency of automatically creating snapshots.
- |
-
-
-
-
-
-
- Example ResponsesStatus code: 200
- Request succeeded.
- {
- "keepday" : 2,
- "frequency" : "DAY",
- "period" : "16:00 GMT+08:00",
- "prefix" : "snapshot",
- "bucket" : "es-backup",
- "basePath" : "css_repository/tests",
- "agency" : "usearch",
- "enable" : "true"
-}
-
- Status Codes
- Status Code
- |
-Description
- |
-
|---|
-
-200
- |
-Request succeeded.
- |
-
-406
- |
-The server could not fulfill the request according to the content characteristics of the request.
- |
-
-
-
-
-
-
- Querying Cluster Details
-FunctionThis API is used to query and display the details of a cluster.
+ FunctionThis API is used to query and display details about a cluster.
- URIGET /v1.0/{project_id}/clusters/{cluster_id}
+ DebuggingYou can debug this API in . Automatic authentication is supported.
+
+ URIGET /v1.0/{project_id}/clusters/{cluster_id}
- Table 1 Path ParametersParameter
+Table 1 Path parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Project ID. For details, see Obtaining a Project ID and Name.
|
-cluster_id
+ | cluster_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-ID of the cluster you want to query.
+ | ID of the cluster to be queried
|
Request ParametersNone
+
- Response ParametersStatus code: 200
+ Response ParametersStatus code: 200
- Table 2 Response body parametersParameter
+Table 2 Response body parameterParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-datastore
+ | datastore
|
-ClusterDetailDatastore object
+ | ClusterDetailDatastore object
|
-Search engine.
+ | Search engine type
|
-instances
+ | instances
|
-Array of ClusterDetailInstances objects
+ | Array of ClusterDetailInstances objects
|
-List of node objects.
+ | Node object list
|
-publicKibanaResp
+ | publicKibanaResp
|
-publicKibanaRespBody object
+ | publicKibanaRespBody object
|
-Kibana public network access information.
+ | Kibana public network access information
|
-elbWhiteList
+ | elbWhiteList
|
-elbWhiteListResp object
+ | elbWhiteListResp object
|
-Public network access information.
+ | Public network access information
|
-updated
+ | updated
|
-String
+ | String
|
-Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
+ | Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
|
-name
+ | name
|
-String
+ | String
|
-Cluster name
+ | Cluster name
|
-publicIp
+ | publicIp
|
-String
+ | String
|
-Public IP address and port number.
+ | Public IP address
|
-created
+ | created
|
-String
+ | String
|
-Cluster creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
+ | Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
|
-id
+ | id
|
-String
+ | String
|
-Cluster ID.
+ | Cluster ID.
|
-status
+ | status
|
-String
+ | String
|
-Cluster status.
-100: An operation, such as creation, is in progress.
-200: Available.
-303: Unavailable, for example, due to a creation failure.
-
+ | Cluster status.
+- 100: The operation, such as instance creation, is in progress.
- 200: The cluster is available.
- 303: The cluster is unavailable.
|
-endpoint
+ | endpoint
|
-String
+ | String
|
-IPv4 address and port number accessed from the cluster's private network. [If the cluster type is KooSearch, this field indicates the internal address and port number for accessing the knowledge management service.] (tag:white)
+ | IP address and port number for accessing VPC
|
-vpcId
+ | vpcId
|
-String
+ | String
|
-VPC ID
+ | VPC ID.
|
-subnetId
+ | subnetId
|
-String
+ | String
|
-Subnet ID
+ | Subnet ID.
|
-securityGroupId
+ | securityGroupId
|
-String
+ | String
|
-Security group ID.
+ | Security group ID
|
-vpcepIp
+ | vpcepIp
|
-String
+ | String
|
-Endpoint IP address.
+ | VPC endpoint IP address
|
-vpcepIpv6Address
+ | bandwidthSize
|
-String
+ | Integer
|
-IPv6 address of the VPC endpoint.
+ | Public network bandwidth Unit: Mbit/s
|
-bandwidthSize
+ | httpsEnable
|
-Integer
+ | Boolean
|
-Public network bandwidth. Unit: Mbit/s
+ | Communication encryption status.
+- Value false indicates that communication encryption is not enabled.
- true: communication encryption has been enabled.
|
-httpsEnable
+ | diskEncrypted
|
-Boolean
+ | Boolean
|
-Communication encryption status.
-
+ | Indicates whether disks are encrypted.
+- Value true indicates that disks are encrypted.
- false: disks are not encrypted.
|
-diskEncrypted
+ | authorityEnable
|
-Boolean
+ | Boolean
|
-Whether disks are encrypted.
-
+ | Indicates whether to enable authentication. The value can be true or false. Authentication is disabled by default.
+- true: authentication is enabled for the cluster.
- false: authentication is disabled for the cluster.
|
-authorityEnable
+ | backupAvailable
|
-Boolean
+ | Boolean
|
-Whether to enable authentication. The value can be true or false. Authentication is disabled by default.
-
+ | Indicates whether the snapshot function is enabled.
+- true: The snapshot function is enabled.
- false: The snapshot function is disabled.
|
-backupAvailable
+ | actionProgress
|
-Boolean
+ | Object
|
-Whether the snapshot function is enabled.
-
+ | Cluster operation progress, which displays the progress of cluster creation or scale-out in percentage.
|
-actionProgress
+ | actions
|
-Object
+ | Array of strings
|
-Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage.
+ | Current behavior of a cluster. The value can be REBOOTING, GROWING, RESTORING, and SNAPSHOTTING.
|
-actions
+ | enterpriseProjectId
|
-Array of strings
+ | String
|
-Current behavior of a cluster. REBOOTING indicates that the cluster is being restarted. GROWING indicates that the cluster is being scaled. RESTORING indicates that the cluster is being restored. SNAPSHOTTING indicates that a snapshot is being created.
+ | ID of the enterprise project to which a cluster belongs.
+If the user of the cluster does not enable the enterprise project, the setting of this parameter is not returned.
|
-enterpriseProjectId
+ | tags
|
-String
+ | Array of ClusterDetailTags objects
|
-ID of the enterprise project that a cluster belongs to.
-If the user of the cluster does not enable the enterprise project, the setting of this parameter is not returned.
+ | Cluster tag
|
-tags
+ | failedReason
|
-Array of ClusterDetailTags objects
+ | ClusterDetailFailedReasons object
|
-Cluster tag.
- |
-
-failedReason
- |
-ClusterDetailFailedReasons object
- |
-Failure cause. If the cluster is in the available status, this parameter is not returned.
- |
-
-bandwidthResourceId
- |
-String
- |
-ID of the resource accessible from the public network.
- |
-
-ipv6Endpoint
- |
-String
- |
-IPv6 address and port number accessible from the cluster's private network.
- |
-
-supportVpcep
- |
-Boolean
- |
-Whether the VPCEP service can be enabled for the current cluster.
+ | Failure cause. If the cluster is in the Available state, this parameter is not returned.
|
Table 3 ClusterDetailDatastoreParameter
+Table 3 ClusterDetailDatastoreParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-type
+ | type
|
-String
+ | String
|
-Engine type. Its value can be elasticsearch or logstash.
+ | Engine type. Currently, only Elasticsearch is supported.
|
-version
+ | version
|
-String
+ | String
|
-Version of the CSS cluster engine. For details, see the supported versions in Before You Start.
- |
-
-supportSecuritymode
- |
-Boolean
- |
-The security mode is supported.
- |
-
-subVersion
- |
-String
- |
-Cluster image version.
- |
-
-isEosCluster
- |
-Boolean
- |
-Whether the cluster image version has reached EOS. The value can be true or false.
+ | CSS cluster engine version. For details, see Supported Cluster Versions.
|
Table 4 ClusterDetailInstancesParameter
+Table 4 ClusterDetailInstancesParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-status
+ | status
|
-String
+ | String
|
-Node status value.
-100: An operation, such as creation, is in progress.
-200: Available.
-303: Unavailable, for example, due to a creation failure.
-
+ | Node status value.
+- 100: The operation, such as instance creation, is in progress.
- 200: The cluster is available.
- 303: The cluster is unavailable.
|
-resourceId
+ | type
|
-String
+ | String
|
-Instance resource ID
+ | Node type
|
-type
+ | id
|
-String
+ | Integer
|
-Type of the current node.
+ | Instance ID
|
-id
+ | name
|
-String
+ | String
|
-Instance ID.
+ | Instance name
|
-name
+ | specCode
|
-String
+ | String
|
-Instance name.
+ | Node specifications.
|
-specCode
+ | azCode
|
-String
+ | String
|
-Node specifications.
+ | AZ to which a node belongs.
|
-azCode
+ | ip
|
-String
+ | String
|
-AZ of a node.
+ | Instance IP address
|
-privateIp
+ | volume
|
-String
+ | ShowClusterVolumeRsp object
|
-Instance IP address.
- |
-
-volume
- |
-ShowClusterVolumeRsp object
- |
-Instance disk information
+ | Instance disk information
|
Table 5 ShowClusterVolumeRspParameter
+Table 5 ShowClusterVolumeRspParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-type
+ | type
|
-String
+ | String
|
-Instance disk type
+ | Instance disk type
|
-size
+ | size
|
-Integer
+ | Integer
|
-Instance disk size
- |
-
-resourceIds
- |
-Array of strings
- |
-Instance disk resource ID
+ | Instance disk size
|
Table 6 publicKibanaRespBodyParameter
+Table 6 publicKibanaRespBodyParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-eipSize
+ | eipSize
|
-Integer
+ | Integer
|
-Bandwidth range. Unit: Mbit/s
+ | Bandwidth. Unit: Mbit/s
|
-elbWhiteListResp
+ | elbWhiteListResp
|
-kibanaElbWhiteListResp object
+ | kibanaElbWhiteListResp object
|
-Kibana public network access information.
+ | Kibana public network access information
|
-publicKibanaIp
+ | publicKibanaIp
|
-String
+ | String
|
-Specifies the IP address for accessing Kibana.
- |
-
-bandwidthResourceId
- |
-String
- |
-Resource ID corresponding to the Kibana public network
+ | Kibana access IP address
|
Table 7 kibanaElbWhiteListRespParameter
+Table 7 kibanaElbWhiteListRespParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-enableWhiteList
+ | enableWhiteList
|
-Boolean
+ | Boolean
|
-Whether the Kibana access control is enabled.
-
+ | Indicates whether access control is enabled.
+- true: Access control is enabled.
- false: Access control is disabled.
|
-whiteList
+ | whiteList
|
-String
+ | String
|
-Whitelist of public network for accessing Kibana.
+ | Whitelist for Kibana public network access
|
Table 8 elbWhiteListRespParameter
+Table 8 elbWhiteListRespParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-enableWhiteList
+ | enableWhiteList
|
-Boolean
+ | Boolean
|
-Whether the public network access control is enabled.
-
+ | Indicates whether public access control is enabled.
+- true: Public network access control is enabled.
- false: Public network access control is disabled.
|
-whiteList
+ | whiteList
|
-String
+ | String
|
-Whitelist for public network access.
+ | Whitelist for public network access
|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|