This API is used to disable log backup or log ingestion for a cluster. Log backup and log ingestion can be disabled separately. After log backup is disabled, any automatic log backup policy configured earlier becomes invalid, and cluster logs cannot be manually back up to OBS either. Disabling log collection for a cluster stops the logs of that cluster from being collected and saved to a specified cluster.
For details, see Calling APIs.
PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/close
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A |
cluster_id |
Yes |
String |
Definition: ID of the cluster for which log backup or ingestion is to be disabled. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
action |
No |
String |
Definition: Disables log backup or log collection. Constraints: You can disable log backup or log ingestion only when they have been enabled for the cluster. For details about how to enable log backup or log ingestion, see Enabling Logs. Value range: Default value: base_log_collect |
None
Status code: 200
Request succeeded.
None
None
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. |
See Error Codes.