Enabling or Disabling Instance Data Export
Function
This API is used to enable or disable instance data export.
Currently, GeminiDB Influx instance data can be converted into a .parquet file and then uploaded to a specified OBS bucket.
Constraints
This API can be used only on performance-enhanced GeminiDB Influx instances.
URI
PUT /v3/{project_id}/instances/{instance_id}/data-dump
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A |
instance_id |
Yes |
String |
Explanation: Instance ID Constraints: N/A Values: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Explanation: User token To obtain this value, call the IAM API for obtaining a user token. Constraints: N/A Values: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
bucket_name |
Yes |
String |
Explanation: OBS bucket name Constraints: N/A Values: N/A Default value: N/A |
action |
Yes |
String |
Explanation: Enables or disables instance data export. Constraints: N/A Values: N/A Default value: N/A |
Response Parameters
Status code: 200
Successful request
Example Request
Enabling or disabling instance data export
PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/0a9a2be86bdf493981d17626ad2f8668in13/data-dump { "bucket_name" : "influxdb-obs", "action" : "open" }
Example Response
None
Status Codes
See Status Codes.
Error Codes
See Status 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