Manager API
API definitions for manager nodes, accessed via manager Docs service and admin tools.
CreateDatasetMetadata
CreateDataset initializes a new dataset in the metadata store with no initial allocated capacity
Request parameters
{
"name": "indexName",
"owner": "Index owner",
"serviceNamePattern": "_all"
}
Responses
{
"name": "indexName",
"owner": "Index owner",
"serviceNamePattern": "_all"
}
{
"code": 81,
"message": "example"
}
GetDatasetMetadata
GetDataset returns a single dataset metadata by name
Request parameters
{
"name": "indexName"
}
Responses
{
"name": "indexName",
"owner": "Index owner",
"throughputBytes": "12000000",
"partitionConfigs": [
{
"startTimeEpochMs": "1706646163791",
"endTimeEpochMs": "1706646250152",
"partitions": [
"0",
"1"
]
},
{
"startTimeEpochMs": "1706646250153",
"endTimeEpochMs": "9223372036854775807",
"partitions": [
"0",
"1",
"2"
]
}
],
"serviceNamePattern": "_all"
}
{
"code": 81,
"message": "example"
}
ListDatasetMetadata
ListDatasets returns all available datasets from the metadata store
Responses
{
"datasetMetadata": [
{
"name": "example",
"owner": "example",
"throughputBytes": "4000000",
"partitionConfigs": [
{
"startTimeEpochMs": "1698967727980",
"endTimeEpochMs": "1698969132808",
"partitions": [
"0"
]
},
{
"startTimeEpochMs": "1698969132809",
"endTimeEpochMs": "1699035709531",
"partitions": [
"0"
]
},
{
"startTimeEpochMs": "1699035709532",
"endTimeEpochMs": "9223372036854775807",
"partitions": [
"0",
"1"
]
}
],
"serviceNamePattern": "_all"
}
]
}
{
"code": 81,
"message": "example"
}
RestoreReplica
Restores replicas matching provided query parameters.
Request parameters
{
"serviceName": "example",
"startTimeEpochMs": "1713375159221",
"endTimeEpochMs": "1713378759221"
}
Responses
{
"status": "success"
}
{
"code": 81,
"message": "example"
}
RestoreReplicaIds
Restores replicas by ID
Request parameters
{
"idsToRestore": [
"f3a94795-71a1-4735-9eb1-60968fbae196"
]
}
Responses
{
"status": "success"
}
{
"code": 81,
"message": "example"
}
UpdateDatasetMetadata
UpdateDataset updates an existing dataset with new metadata
Request parameters
{
"name": "example",
"owner": "Updated owner",
"serviceNamePattern": "_all"
}
Responses
{
"name": "example",
"owner": "Updated owner",
"serviceNamePattern": "_all"
}
{
"code": 81,
"message": "example"
}
UpdatePartitionAssignment
UpdatePartitionAssignment allocates a new partition assignment for a dataset. If a rate and a list of partition_ids are provided, it will use it use the list of partition ids as the current allocation and invalidates the existing assignment.
Request parameters
{
"name": "example",
"throughputBytes": "4000000",
"partitionIds": [
"0"
]
}
{
"name": "example",
"throughputBytes": "4000000",
"partitionIds": []
}
Responses
{
"assignedPartitionIds": [
"0"
]
}
{
"code": 81,
"message": "example"
}
Last modified: 03 September 2024