Querying the Configuration File Content
Function
This API is used to query the configuration file content.
Debugging
You can debug this API through automatic authentication in API Explorer.
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/confdetail
Parameter |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Configuration file name. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
name |
String |
Configuration file name. |
status |
String |
Configuration file status. |
confContent |
String |
Configuration file content. |
setting |
setting object |
Configuration content object. |
updateAt |
String |
Update time. |
Parameter |
Type |
Description |
---|---|---|
workers |
Integer |
Number of working threads in the Filters and Outputs phases of parallel pipelines. The default value is the number of CPU cores. |
batchSize |
Integer |
Maximum number of events that a worker thread collects from inputs before attempting to execute its filters and outputs. A larger value is more effective but increases memory overhead. The default value is 125. |
batchDelayMs |
Integer |
Minimum waiting time of an event to be scheduled by the pipeline. The unit is millisecond. |
queueType |
String |
An internal queue model for event buffering. memory indicates a traditional in-memory queue, and persisted indicates a disk-based ACKed persistent queue. The default value is memory. |
queueCheckPointWrites |
Integer |
Maximum number of written events before forcing a checkpoint when persistent queues are enabled. The default value is 1024. |
queueMaxBytesMb |
Integer |
Total capacity of the persistent queue in unit of MB. Make sure the capacity of your disk drive is greater than the value you specify here. The default value is 1024 MB. |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "name" : "conf1", "status" : "available", "confContent" : "xxxxxxxx", "setting" : { "workers" : 2, "batchSize" : 125, "batchDelayMs" : 50, "queueType" : "persisted", "queueCheckPointWrites" : 1024, "queueMaxBytesMb" : 1024 }, "updateAt" : "2021-09-29T02:44:44" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Invalid request. The client should modify the request instead of re-initiating it. |
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 did not meet one of the preconditions contained in the request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot