Definitions
AgentConfig
Name | Schema |
---|---|
catalog_activity_update_interval_seconds |
integer |
enable_topology_force_update |
boolean |
heartbeat_interval_seconds |
integer |
query_activity_update_interval_seconds |
integer |
topology_update_interval_seconds |
integer |
Backup
Name | Schema |
---|---|
id |
string |
is_automatic |
boolean |
size_bytes |
string |
status |
string |
tag |
string |
time |
string |
type |
string |
version |
string |
BackupRestoreStatus
Name | Schema |
---|---|
created_at |
string |
name |
string |
output |
string |
status |
string |
BackupSchedule
Name | Schema |
---|---|
max_backup_files |
integer |
max_reserved_days |
integer |
max_retry |
integer |
pause |
boolean |
schedule |
string |
CreateWorkgroupRequest
Name | Schema |
---|---|
cloud_provider_id |
string |
name |
string |
platform |
|
region |
string |
CreateWorkspaceRequest
Create Workspace Request
Name | Description | Schema |
---|---|---|
addons |
< WorkspaceAddonsRequest > array |
|
auto_stop_minutes |
integer |
|
enable_auto_start |
boolean |
|
enable_ha |
boolean |
|
is_rw |
boolean |
|
name |
string |
|
solution_install_request |
||
tg_database_id |
string |
|
tg_version |
string |
|
workspace_type_name |
Workspace Type Name TG-0/TG-2 |
string |
FolderStatistics
Name | Schema |
---|---|
backup_size |
integer |
billed_size |
integer |
log_size |
integer |
milvus_size |
integer |
total_size |
integer |
workspaces |
< WorkspaceSize > array |
SolutionInstallRequest
Name | Schema |
---|---|
addons |
< WorkspaceAddonsRequest > array |
data_source_origin |
string |
name |
string |
solution_catalog_id |
string |
TGDatabase
Name | Schema |
---|---|
create_time |
string |
database_id |
string |
folder_statistics |
|
name |
string |
org_id |
string |
org_name |
string |
region |
string |
tg_version |
string |
workgroup_id |
string |
workspaces |
< Workspace > array |
UpdateWorkspaceRequest
Name | Description | Schema |
---|---|---|
addons |
< WorkspaceAddonsRequest > array |
|
agent_config |
||
auto_stop_minutes |
Minimum value : |
integer |
enable_auto_start |
boolean |
|
enable_ha |
boolean |
|
pause |
boolean |
|
workspace_name |
string |
|
workspace_type_name |
string |
Workgroup
Name | Schema |
---|---|
cloud_provider_id |
string |
creator |
string |
enable_allow_list |
boolean |
name |
string |
org_id |
string |
org_name |
string |
platform |
|
region |
string |
tg_databases |
< TGDatabase > array |
workgroup_id |
string |
workspaces |
< Workspace > array |
Workspace
Name | Schema |
---|---|
addons |
< WorkspaceAddonsRequest > array |
agent_config |
|
auto_stop_minutes |
integer |
cloud_provider_id |
string |
condition_type |
string |
created_at |
string |
creator |
string |
database_id |
string |
edge_count |
integer |
enable_auto_start |
boolean |
enable_copilot |
boolean |
enable_ha |
boolean |
folder_statistics |
|
graph_topology_size_bytes |
integer |
is_rw |
boolean |
last_modified_time |
string |
name |
string |
nginx_host |
string |
org_id |
string |
org_name |
string |
refresh_message |
string |
refresh_status |
string |
region |
string |
size |
integer |
snapshot_time |
string |
solution_catalog_id |
string |
status |
string |
tg_version |
string |
version_number |
integer |
vertex_count |
integer |
workgroup_id |
string |
workgroup_name |
string |
workspace_id |
string |
workspace_type |
WorkspaceSchedule
Name | Schema |
---|---|
date |
string |
id |
string |
repeat |
string |
repeat_on |
string |
time |
string |
timezone |
string |
workspace_id |
string |
workspace_type_name |
string |
WorkspaceType
Name | Schema |
---|---|
cpu |
string |
ha |
integer |
memory |
string |
partition |
integer |
typeName |
string |
middleware.ErrorType
Type : enum (Internal-Error, Bad-Request, Not-Found, Forbidden, Unauthorized, API-Disabled, Quota-Exceed, Unknown)
middleware.Response
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
object |
org_handler.OrgListUserResponse
Name | Schema |
---|---|
auth0UserID |
string |
authID |
string |
created |
string |
email |
string |
enabled |
boolean |
firstName |
string |
id |
string |
lastName |
string |
metadata |
|
path |
string |
roles |
< org_handler.OrgRole > array |
tenantID |
string |
trn |
string |
updated |
string |
username |
string |
org_handler.OrgRole
Name | Schema |
---|---|
displayName |
string |
id |
string |
name |
string |
path |
string |
tenantID |
string |
trn |
string |
pb.APIKey
Name | Schema |
---|---|
created_at |
string |
creator |
string |
description |
string |
expires_at |
string |
key_name |
string |
org_id |
string |
plaintext_key |
string |
redacted_key |
string |
user_id |
string |
pb.CreateAPIKeyRequest
Name | Schema |
---|---|
description |
string |
life_time_in_seconds |
integer |
pb.CustomerCreditCard
Name | Schema |
---|---|
brand |
string |
card_id |
string |
expire_month |
integer |
expire_year |
integer |
last_4_digits |
string |
name_on_card |
string |
org_id |
string |
pb.DataStoragePricing
Name | Schema |
---|---|
platform |
string |
price_per_month |
number |
region |
string |
pb.GetCustomerCreditCardsResponse
Name | Schema |
---|---|
credit_cards |
< pb.CustomerCreditCard > array |
default_card |
string |
pb.OrgQuota
Name | Schema |
---|---|
max_workspace_memory |
string |
max_workspace_type |
string |
memory_limit |
string |
memory_usage_in_bytes |
integer |
org_id |
string |
ro_workspace_count_limit |
integer |
ro_workspace_count_usage |
integer |
rw_workspace_count_limit |
integer |
rw_workspace_count_usage |
integer |
tier |
string |
workspace_auto_backup_count_limit |
integer |
workspace_auto_backup_retention_in_days |
integer |
workspace_manual_backup_count_limit |
integer |
pb.Organization
Name | Schema |
---|---|
create_time |
string |
creator |
string |
feature_flag |
< pb.FeatureFlag > array |
logo_url |
string |
org_display_name |
string |
org_id |
string |
org_name |
string |
pb.ResourcePricing
Name | Schema |
---|---|
addon_pricing |
< pb.AddOnPricing > array |
data_storage_pricing |
< pb.DataStoragePricing > array |
workspace_pricing |
< pb.WorkspacePricing > array |
pb.WorkspacePricing
Name | Schema |
---|---|
cloud_provider |
string |
ha |
string |
platform |
string |
price_per_hour |
number |
region |
string |
workspace_type |
string |
resource_manager_handler.GetMetadata.metadata
Name | Schema |
---|---|
regions |
< Region > array |
tgVersions |
< TGVersion > array |
workspaceTypes |
< WorkspaceType > array |
tgIAM.IAMUser
Name | Schema |
---|---|
auth0UserID |
string |
created |
string |
email |
string |
enabled |
boolean |
firstName |
string |
id |
string |
lastName |
string |
path |
string |
tenantID |
string |
trn |
string |
updated |
string |
username |
string |