The following is an example response. For example, if CSS is deployed in region
xxx, the value of
name in the response body is
xxx. The value of
id in
projects is the project ID.
{
diff --git a/docs/css/api-ref/css_03_0073.html b/docs/css/api-ref/css_03_0073.html
deleted file mode 100644
index 1e18c6538..000000000
--- a/docs/css/api-ref/css_03_0073.html
+++ /dev/null
@@ -1,88 +0,0 @@
-
-
-Common Request Parameters
-Table 1 describes the common request parameters.
-
-
Table 1 Common request headersParameter
- |
-Mandatory
- |
-Description
- |
-
|---|
-
-X-Sdk-Date
- |
-This parameter is mandatory for authentication using AK/SK.
- |
-Time when the request is sent. The time is in the YYYYMMDD'T'HHMMSS'Z' format.
-The value is the current GMT time of the system.
- |
-
-Authorization
- |
-This parameter is mandatory for authentication using AK/SK.
- |
-Signature authentication information. The value can be obtained from the request signing result.
-See Authentication.
- |
-
-Host
- |
-This parameter is mandatory for authentication using AK/SK.
- |
-Server domain name and port number of the resource being requested. The value can be obtained from the URL of the service API. The value is hostname[:port]. If the port number is not specified, the default port is used. The default port number for https is 443.
- |
-
-Content-Type
- |
-Yes
- |
-MIME type of the request body.
- |
-
-Content-Length
- |
-This parameter is mandatory for POST and PUT requests, but must be left blank for GET requests.
- |
-Length of the request body. The unit is byte.
- |
-
-X-Project-Id
- |
-No
- |
-Project ID. This parameter is used to obtain the token for each project.
- |
-
-X-Auth-Token
- |
-No (This parameter is mandatory for authentication using tokens.)
- |
-User token.
- |
-
-X-Language
- |
-No
- |
-Request language. The value is en-us.
- |
-
-Accept
- |
-No
- |
-Type of content that can be received by a client.
- |
-
-
-
-
-
Common Response Parameters
-Table 1 describes common response headers.
-
-
Table 1 Common response headersName
- |
-Description
- |
-
|---|
-
-Content-Length
- |
-Length of the response body. The unit is byte.
- |
-
-Date
- |
-Time when a request response is returned.
- |
-
-Content-Type
- |
-MIME type of the request body.
- |
-
-
-
-
-
Renaming a Cluster
+Function
This API is used to change the password of a cluster.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset
+
+
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 password you want to change.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+newpassword
+ |
+Yes
+ |
+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 (~!@#$%^&*()-_=+\|[{}];:,<.>/?).
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "newpassword" : "xxxxxx"
+}
+
+
+
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
+Function
This API is used to change the password of a cluster.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset
+
+
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 password you want to change.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+newpassword
+ |
+Yes
+ |
+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 (~!@#$%^&*()-_=+\|[{}];:,<.>/?).
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "newpassword" : "xxxxxx"
+}
+
+
+
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 Specifications
+Function
This API is used to modify the specifications of a cluster. Only the nodes of the ESS type can be modified.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/flavor
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose specifications you want to change.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+needCheckReplica
+ |
+No
+ |
+Boolean
+ |
+Whether to check replicas. The value can be true or false. The check is enabled by default.
+- true: Replicas are checked.
- false: Replicas are not checked.
+ |
+
+newFlavorId
+ |
+Yes
+ |
+String
+ |
+ID of the new flavor. This parameter is obtained by calling the Obtaining the List of Instance Flavors API. The API compares the values of the name attribute and obtains the ID of the flavor higher than the current flavor. Only the node specifications of the same Elasticsearch engine version can be changed.
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "needCheckReplica" : false,
+ "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2"
+}
+
+
+
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 Specifications of a Specified Node Type
+Function
This API is used to modify cluster specifications. The following node types can be changed:
+
- ess: data node
- ess-cold: cold data node
- ess-client: client node
- ess-master: master node
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/{types}/flavor
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose specifications you want to change.
+ |
+
+types
+ |
+Yes
+ |
+String
+ |
+Type of the cluster node you want to modify.
+- ess: data node
- ess-cold: cold data node
- ess-client: client node
- ess-master: master node
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+needCheckReplica
+ |
+No
+ |
+Boolean
+ |
+Whether to check replicas. The value can be true or false. The check is enabled by default.
+- true: Replicas are checked.
- false: Replicas are not checked.
+Master and client nodes are not data nodes, so they do not need to check replicas no matter this parameter is set to true or false.
+ |
+
+newFlavorId
+ |
+Yes
+ |
+String
+ |
+ID of the new flavor. This parameter is obtained by calling the Obtaining the List of Instance Flavors API. The API compares the values of the name attribute and obtains the ID of the flavor higher than the current flavor. Only the node specifications of the same Elasticsearch engine version can be changed.
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "needCheckReplica" : false,
+ "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2"
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Scaling In a Cluster by Removing a Specific Node
+Function
This API is used to scale in a cluster by removing a specified node.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/node/offline
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster you want to scale in.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+shrinkNodes
+ |
+Yes
+ |
+Array of strings
+ |
+ID of the node you want to remove from a cluster.
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "shrinkNodes" : [ "2077bdf3-b90d-412e-b460-635b9b159c11" ]
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Scaling In Nodes of a Specific Type
+Function
This API is used to remove instances of different types and reduce instance storage capacity in a cluster.
+
+
URI
POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster you want to scale in.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+shrink
+ |
+Yes
+ |
+Array of ShrinkNodeReq objects
+ |
+Type and quantity of nodes you want to remove from a cluster.
+ |
+
+
+
+
+
+
Table 3 ShrinkNodeReqParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+reducedNodeNum
+ |
+Yes
+ |
+Integer
+ |
+Number of nodes you want to remove from a cluster.
+- After the scale-in, there has to be at least one node in each AZ under each node type.
- In a cross-AZ cluster, the difference between the numbers of the same type nodes in different AZs cannot exceed 1.
- For a cluster without master nodes, the number of removed data nodes (including cold data nodes and other types of nodes) in a scale-in must be fewer than half of the original data node number, and the number of remaining data nodes after a scale-in must be greater than the maximum number of index replicas.For a cluster with master nodes, the number of removed master nodes in a scale-in must be fewer than half of the original master node number. After scale-in, there has to be an odd number of master nodes, and there has to be at least three of them.
+ |
+
+type
+ |
+Yes
+ |
+String
+ |
+Node type.
+- ess: data node
- ess-cold: cold data node
- ess-client: client node
- ess-master: master node
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "shrink" : [ {
+ "type" : "ess",
+ "reducedNodeNum" : 1
+ } ]
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Log Management
+
+
+
+
+
diff --git a/docs/css/api-ref/css_03_0094.html b/docs/css/api-ref/css_03_0094.html
new file mode 100644
index 000000000..0ea2d446b
--- /dev/null
+++ b/docs/css/api-ref/css_03_0094.html
@@ -0,0 +1,131 @@
+
+
+Enabling the Log Function
+Function
This API is used to enable the log function.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/logs/open
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose log function you want to enable.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+agency
+ |
+Yes
+ |
+String
+ |
+Agency name. You can create an agency to allow CSS to call other cloud services.
+ |
+
+logBasePath
+ |
+Yes
+ |
+String
+ |
+Storage path of backed up logs in the OBS bucket.
+ |
+
+logBucket
+ |
+Yes
+ |
+String
+ |
+Name of the OBS bucket for storing logs.
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "agency" : "css_obs_agency",
+ "logBasePath" : "css/log",
+ "logBucket" : "000-words"
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Disabling the Log Function
+Function
This API is used to disable the log function.
+
+
URI
PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/close
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose log function you want to disable.
+ |
+
+
+
+
+
+
+
Response Parameters
None
+
+
+
+
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 Job List
+Function
This API is used to query the job list in the logs of a cluster.
+
+
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster you want to query.
+ |
+
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 2 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+clusterLogRecord
+ |
+Array of clusterLogRecord objects
+ |
+Cluster log entity object.
+ |
+
+
+
+
+
+
Table 3 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
+- RUNNING: The line is being backed up.
- SUCCESS: The backup succeeded.
- FAIL: The backup failed.
+ |
+
+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 Responses
Status 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 Basic Log Configurations
+Function
This API is used to query basic log configurations.
+
+
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster you want to query.
+ |
+
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 2 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+logConfiguration
+ |
+logConfiguration object
+ |
+Log configuration entity object.
+ |
+
+
+
+
+
+
Table 3 logConfigurationParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Log backup ID, which is generated using the system UUID.
+ |
+
+clusterId
+ |
+String
+ |
+Cluster ID.
+ |
+
+obsBucket
+ |
+String
+ |
+Name of the OBS bucket for storing logs.
+ |
+
+agency
+ |
+String
+ |
+Agency name. You can create an agency to allow CSS to call other cloud services.
+ |
+
+updateAt
+ |
+Long
+ |
+Update time. Format: Unix timestamp.
+ |
+
+basePath
+ |
+String
+ |
+Storage path of backed up logs in the OBS bucket.
+ |
+
+autoEnable
+ |
+Boolean
+ |
+Whether the automatic backup is enabled.
+- true: Automatic backup is enabled.
- false: Automatic backup is disabled.
+ |
+
+period
+ |
+String
+ |
+Start time of automatic log backup. If autoEnable is set to false, the value of this parameter is null. Format: GMT
+ |
+
+logSwitch
+ |
+Boolean
+ |
+Whether the log function is enabled.
+- true: The log function is enabled.
- false: The log function is disabled.
+ |
+
+
+
+
+
+
+
Example Responses
Status code: 200
+
Request succeeded.
+
{
+ "logConfiguration" : {
+ "id" : "d455a541-597e-4846-a6be-baad0ea361b1",
+ "clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
+ "obsBucket" : "css-auto-test",
+ "agency" : "css_obs_agency",
+ "updateAt" : 1633663681055,
+ "basePath" : "css/log",
+ "autoEnable" : false,
+ "period" : "16:00 GMT+02:00",
+ "logSwitch" : true
+ }
+}
+
+
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.
+ |
+
+
+
+
+
+
Modifying Basic Log Configurations
+Function
This API is used to modify basic log configurations.
+
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settings
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose basic log configurations you want to modify.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+agency
+ |
+Yes
+ |
+String
+ |
+Agency name. You can create an agency to allow CSS to call other cloud services.
+ |
+
+logBasePath
+ |
+Yes
+ |
+String
+ |
+Storage path of backed up logs in the OBS bucket.
+ |
+
+logBucket
+ |
+Yes
+ |
+String
+ |
+Name of the OBS bucket for storing logs.
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "agency" : "css_obs_agency",
+ "logBasePath" : "css/log",
+ "logBucket" : "000-words"
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Enabling the Automatic Log Backup Policy
+Function
This API is used to enable the automatic log backup policy.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/update
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose log backup policy you want to enable.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+period
+ |
+Yes
+ |
+String
+ |
+Backup start time. Format: GMT
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "period" : "16:00 GMT+02:00"
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Disabling the Automatic Log Backup Policy
+Function
This API is used to disable the automatic log backup policy.
+
+
+
URI
PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/close
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose automatic log backup policy you want to disable.
+ |
+
+
+
+
+
+
+
Response Parameters
None
+
+
+
+
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.
+ |
+
+
+
+
+
+
Backing Up Logs
+Function
This API is used to back up logs.
+
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collect
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose logs you want to back up.
+ |
+
+
+
+
+
+
+
Response Parameters
None
+
+
+
+
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.
+ |
+
+
+
+
+
+
Searching for Logs
+Function
This API is used to query log information.
+
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/logs/search
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster you want to query.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+instanceName
+ |
+Yes
+ |
+String
+ |
+Node name.
+ |
+
+level
+ |
+Yes
+ |
+String
+ |
+Log level. The levels of logs that can be queried are INFO, ERROR, DEBUG, and WARN.
+ |
+
+logType
+ |
+Yes
+ |
+String
+ |
+Log type. The types of logs that can be queried are deprecation, indexingSlow, searchSlow, and instance.
+ |
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+logList
+ |
+Array of logList objects
+ |
+Log list.
+ |
+
+
+
+
+
+
Table 4 logListParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+content
+ |
+String
+ |
+Log content.
+ |
+
+date
+ |
+String
+ |
+Date.
+ |
+
+level
+ |
+String
+ |
+Log level.
+ |
+
+
+
+
+
+
Example Requests
{
+ "instanceName" : "css-4312-ess-esn-1-1",
+ "level" : "INFO",
+ "logType" : "instance"
+}
+
+
Example Responses
Status code: 200
+
Request succeeded.
+
{
+ "logList" : [ {
+ "content" : "xxxxxx",
+ "date" : "2021-10-08T03:55:54,718",
+ "level" : "INFO"
+ } ]
+}
+
+
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.
+ |
+
+
+
+
+
+
Public Network Access
+
+
+
+
+
diff --git a/docs/css/api-ref/css_03_0104.html b/docs/css/api-ref/css_03_0104.html
new file mode 100644
index 000000000..ed74103e1
--- /dev/null
+++ b/docs/css/api-ref/css_03_0104.html
@@ -0,0 +1,184 @@
+
+
+Enabling Public Network Access
+Function
This API is used to enable public network access.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/public/open
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a 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 Parameters
Status 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 Responses
Status 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.
+ |
+
+
+
+
+
+
Disabling Public Network Access
+Function
This API is used to disable public network access to Kibana.
+
+
URI
PUT /v1.0/{project_id}/clusters/{cluster_id}/public/close
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose public network access you want to disable.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+eip
+ |
+No
+ |
+UnBindPublicReqEipReq object
+ |
+EIP information.
+ |
+
+
+
+
+
+
Table 3 UnBindPublicReqEipReqParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+bandWidth
+ |
+No
+ |
+BindPublicReqEipBandWidth object
+ |
+Public network bandwidth.
+ |
+
+
+
+
+
+
Table 4 BindPublicReqEipBandWidthParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+size
+ |
+Yes
+ |
+Integer
+ |
+Bandwidth range. Unit: Mbit/s
+ |
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+action
+ |
+String
+ |
+Operations. The fixed value is unbindZone, indicating that the unbinding is successful.
+ |
+
+
+
+
+
+
Example Requests
{
+ "eip" : {
+ "bandWidth" : {
+ "size" : 5
+ }
+ }
+}
+
+
Example Responses
Status code: 200
+
Request succeeded.
+
{
+ "action" : "unbindZone"
+}
+
+
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.
+ |
+
+
+
+
+
+
Modifying Public Network Access Bandwidth
+Function
This API is used to modify the public network access bandwidth.
+
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidth
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose public network access bandwidth you want to modify.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+bandWidth
+ |
+Yes
+ |
+BindPublicReqEipBandWidth object
+ |
+Public network bandwidth.
+ |
+
+
+
+
+
+
Table 3 BindPublicReqEipBandWidthParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+size
+ |
+Yes
+ |
+Integer
+ |
+Bandwidth range. Unit: Mbit/s
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "bandWidth" : {
+ "size" : 5
+ }
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Enabling the Public Network Access Control Whitelist
+Function
This API is used to enable the public network access control whitelist.
+
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose public network access control whitelist you want to enable.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+whiteList
+ |
+Yes
+ |
+String
+ |
+IP address of the user for whom the whitelist is enabled.
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "whiteList" : "192.168.0.xx"
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Disabling the Public Network Access Control Whitelist
+Function
This API is used to disable the public network access control whitelist.
+
+
URI
PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/close
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose public network access control whitelist you want to disable.
+ |
+
+
+
+
+
+
+
Response Parameters
None
+
+
+
+
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.
+ |
+
+
+
+
+
+
VPC Endpoint
+
+
+
+
+
diff --git a/docs/css/api-ref/css_03_0110.html b/docs/css/api-ref/css_03_0110.html
new file mode 100644
index 000000000..0508ef568
--- /dev/null
+++ b/docs/css/api-ref/css_03_0110.html
@@ -0,0 +1,135 @@
+
+
+Enabling the VPC Endpoint Service
+Function
This API is used to enable the VPC endpoint service.
+
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/open
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose VPC endpoint you want to enable.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+endpointWithDnsName
+ |
+No
+ |
+Boolean
+ |
+Enable the VPC endpoint.
+ |
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+action
+ |
+String
+ |
+Operations. The fixed value is createVpcepservice, indicating that the VPC endpoint is enabled.
+ |
+
+
+
+
+
+
Example Requests
{
+ "endpointWithDnsName" : true
+}
+
+
Example Responses
Status code: 200
+
Request succeeded.
+
{
+ "action" : "createVpcepservice"
+}
+
+
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.
+ |
+
+
+
+
+
+
Disabling the VPC Endpoint Service
+Function
This API is used to disable the VPC endpoint service.
+
+
URI
PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/close
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose VPC endpoint you want to disable.
+ |
+
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 2 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+action
+ |
+String
+ |
+Operations. The fixed value is deleteVpcepservice, indicating that the VPC endpoint has been disabled.
+ |
+
+
+
+
+
+
+
Example Responses
Status code: 200
+
Request succeeded.
+
{
+ "action" : "deleteVpcepservice"
+}
+
+
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 an Endpoint Connection
+Function
This API is used to obtain a VPC endpoint connection.
+
+
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster you want to query.
+ |
+
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 2 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+connections
+ |
+Array of connections objects
+ |
+Connection information.
+ |
+
+vpcepUpdateSwitch
+ |
+Boolean
+ |
+Whether to update endpoints.
+- true: The VPC endpoint is enabled.
- false: The VPC endpoint is disabled.
+ |
+
+total_count
+ |
+Integer
+ |
+Number of endpoints.
+ |
+
+
+
+
+
+
Table 3 connectionsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Endpoint ID.
+ |
+
+status
+ |
+String
+ |
+Endpoint status.
+- accepted: The VPC endpoint connection is enabled.
- rejected: The VPC endpoint connection is disabled.
+ |
+
+maxSession
+ |
+String
+ |
+Maximum number of connections.
+ |
+
+specificationName
+ |
+String
+ |
+Endpoint name.
+ |
+
+created_at
+ |
+String
+ |
+Creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
+ |
+
+update_at
+ |
+String
+ |
+Update time. The default value is null.
+ |
+
+domain_id
+ |
+String
+ |
+Owner.
+ |
+
+
+
+
+
+
+
Example Responses
Status code: 200
+
Request succeeded.
+
{
+ "connections" : [ {
+ "id" : "connectionsID",
+ "status" : "accepted",
+ "maxSession" : "3000",
+ "specificationName" : "default",
+ "created_at" : "2021-09-17T08:00:07Z",
+ "update_at" : null,
+ "domain_id" : "domainID"
+ } ],
+ "vpcepUpdateSwitch" : "false",
+ "total_count" : 1
+}
+
+
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.
+ |
+
+
+
+
+
+
Updating an Endpoint Connection
+Function
This API is used to update an endpoint connection.
+
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections
+
+
Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details, see Obtaining a Project ID and Name.
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+ID of the cluster whose VPC endpoint you want to update.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+action
+ |
+Yes
+ |
+String
+ |
+Expected operation behavior.
+- receive: The VPC endpoint connection is enabled.
- reject: The VPC endpoint connection is disabled.
+ |
+
+endpointIdList
+ |
+Yes
+ |
+Array of strings
+ |
+Lists VPC endpoint IDs.
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "action" : "receive",
+ "endpointIdList" : [ "f132bb14-e1d5-4f25-9f7c-a29e4c8effd4" ]
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Modifying the Endpoint Service Whitelist
+Function
This API is used to modify the endpoint service whitelist.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissions
+
+
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
+ |
+
|---|
+
+vpcPermissions
+ |
+Yes
+ |
+Array of strings
+ |
+Whitelist (user account ID).
+ |
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
{
+ "vpcPermissions" : [ "dffef70c1db243cbb373e45791165281" ]
+}
+
+
+
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.
+ |
+
+
+
+
+
+
Parameter Configuration
+
+
+
+
+
diff --git a/docs/css/api-ref/css_03_0116.html b/docs/css/api-ref/css_03_0116.html
new file mode 100644
index 000000000..2359cd588
--- /dev/null
+++ b/docs/css/api-ref/css_03_0116.html
@@ -0,0 +1,204 @@
+
+
+Modifying Cluster Parameters
+Function
This API is used to modify the parameter settings of a cluster.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update
+
+
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 parameter settings you want to be modify.
+ |
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+edit
+ |
+Yes
+ |
+UpdateYmlsReqEdit object
+ |
+Configuration file information.
+ |
+
+
+
+
+
+
Table 3 UpdateYmlsReqEditParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+modify
+ |
+Yes
+ |
+UpdateYmlsReqEditModify object
+ |
+Operations on the configuration file.
+- modify: Modify parameter settings.
- delete: Delete parameter settings.
- reset: Reset parameter settings.
+ |
+
+
+
+
+
+
Table 4 UpdateYmlsReqEditModifyParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+elasticsearch.yml
+ |
+Yes
+ |
+Object
+ |
+Parameter configuration list. The value is the JSON data you want to modify.
+ |
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+acknowledged
+ |
+Boolean
+ |
+Whether the modification is successful.
+- true: The modification succeeded.
- false: The modification failed.
+ |
+
+externalMessage
+ |
+String
+ |
+Error message. If acknowledged was set to true, null is returned for this field.
+ |
+
+httpErrorResponse
+ |
+String
+ |
+HTTP error information. The default value is null.
+ |
+
+
+
+
+
+
Example Requests
{
+ "edit" : {
+ "modify" : {
+ "elasticsearch.yml" : {
+ "thread_pool.force_merge.size" : 1
+ }
+ }
+ }
+}
+
+
Example Responses
Status code: 200
+
Request succeeded.
+
{
+ "acknowledged" : true,
+ "externalMessage" : null,
+ "httpErrorResponse" : null
+}
+
+
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
+Function
This API is used to obtain the parameter configuration task list of a cluster.
+
+
URI
GET /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.
+ |
+
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 2 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+configList
+ |
+Array of configListRsp objects
+ |
+List of historical configuration changes
+ |
+
+
+
+
+
+
Table 3 configListRspParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Operation ID.
+ |
+
+clusterId
+ |
+String
+ |
+Cluster ID.
+ |
+
+createAt
+ |
+String
+ |
+Creation time. Format: Unix timestamp.
+ |
+
+status
+ |
+String
+ |
+Task execution status.
+- true: The operation is successful.
- false: The execution failed.
+ |
+
+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 Responses
Status 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.
+ |
+
+
+
+
+
+
Obtaining the Parameter Configuration List
+Function
This API is used to obtain the parameter configuration list of the current cluster.
+
+
URI
GET /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 Parameters
Status 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 Responses
Status 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.
+ |
+
+
+
+
+
+
