From 42f46a45190c8d1e7d2be94d50c7f87fcec5aace Mon Sep 17 00:00:00 2001 From: Sanghun Lee Date: Wed, 15 Jan 2025 18:35:44 +0900 Subject: [PATCH 1/4] fix: allow VFolder id as name parameter in API --- src/ai/backend/manager/api/vfolder.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/ai/backend/manager/api/vfolder.py b/src/ai/backend/manager/api/vfolder.py index bd8fe36eccc..37f893ba16a 100644 --- a/src/ai/backend/manager/api/vfolder.py +++ b/src/ai/backend/manager/api/vfolder.py @@ -248,7 +248,11 @@ async def resolve_vfolder_rows( match folder_id_or_name: case str(): - extra_vf_conds = vfolders.c.name == folder_id_or_name + try: + folder_id = uuid.UUID(folder_id_or_name) + extra_vf_conds = vfolders.c.id == folder_id + except ValueError: + extra_vf_conds = vfolders.c.name == folder_id_or_name case uuid.UUID(): extra_vf_conds = vfolders.c.id == folder_id_or_name case _: From 36f75e8527245edb8f519d9ebdc036bd4ae4630b Mon Sep 17 00:00:00 2001 From: Sanghun Lee Date: Wed, 15 Jan 2025 18:48:34 +0900 Subject: [PATCH 2/4] add news fragment --- changes/3469.fix.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 changes/3469.fix.md diff --git a/changes/3469.fix.md b/changes/3469.fix.md new file mode 100644 index 00000000000..6cbd1b01579 --- /dev/null +++ b/changes/3469.fix.md @@ -0,0 +1 @@ +Allow VFolder ID as name parameter in API From 983a2b08676d503cd33b7c1ba229a17d3ecfbc59 Mon Sep 17 00:00:00 2001 From: Sanghun Lee Date: Wed, 15 Jan 2025 20:33:01 +0900 Subject: [PATCH 3/4] allow unshare any status of vfolders --- src/ai/backend/manager/api/vfolder.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/ai/backend/manager/api/vfolder.py b/src/ai/backend/manager/api/vfolder.py index 37f893ba16a..8357876d086 100644 --- a/src/ai/backend/manager/api/vfolder.py +++ b/src/ai/backend/manager/api/vfolder.py @@ -2183,7 +2183,7 @@ async def share(request: web.Request, params: Any, row: VFolderRow) -> web.Respo @admin_required @server_status_required(ALL_ALLOWED) @with_vfolder_rows_resolved(VFolderPermission.OWNER_PERM) -@with_vfolder_status_checked(VFolderStatusSet.UPDATABLE) +@with_vfolder_status_checked(VFolderStatusSet.ALL) @check_api_params( t.Dict({ t.Key("emails"): t.List(t.String), @@ -2660,7 +2660,7 @@ async def restore(request: web.Request, params: RestoreRequestModel) -> web.Resp @auth_required @server_status_required(ALL_ALLOWED) @with_vfolder_rows_resolved(VFolderPermissionSetAlias.READABLE) -@with_vfolder_status_checked(VFolderStatusSet.UPDATABLE) +@with_vfolder_status_checked(VFolderStatusSet.ALL) @check_api_params( t.Dict({ tx.AliasedKey(["shared_user_uuid", "sharedUserUuid"], default=None): t.String | t.Null, From a0f153f04846a91e0094938711d07e629abe4d77 Mon Sep 17 00:00:00 2001 From: Sanghun Lee Date: Wed, 15 Jan 2025 11:35:11 +0000 Subject: [PATCH 4/4] chore: update api schema dump Co-authored-by: octodog --- docs/manager/rest-reference/openapi.json | 204 +++++++++++------------ 1 file changed, 102 insertions(+), 102 deletions(-) diff --git a/docs/manager/rest-reference/openapi.json b/docs/manager/rest-reference/openapi.json index 6b888d1ea35..925a6a6d3ac 100644 --- a/docs/manager/rest-reference/openapi.json +++ b/docs/manager/rest-reference/openapi.json @@ -1445,7 +1445,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/events/session": { @@ -1515,7 +1515,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/auth": { @@ -2099,7 +2099,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "folders.delete_by_id", @@ -2155,7 +2155,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "folders.delete_by_name", @@ -2255,7 +2255,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/_/all-hosts": { @@ -2275,7 +2275,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/_/allowed-types": { @@ -2295,7 +2295,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/_/all_hosts": { @@ -2315,7 +2315,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/_/allowed_types": { @@ -2335,7 +2335,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/_/perf-metric": { @@ -2364,7 +2364,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/rename": { @@ -2521,7 +2521,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/request-upload": { @@ -2572,7 +2572,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/request-download": { @@ -2623,7 +2623,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/move-file": { @@ -2674,7 +2674,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/rename-file": { @@ -2729,7 +2729,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/delete-files": { @@ -2783,7 +2783,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "folders.delete_files.2", @@ -2829,7 +2829,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/rename_file": { @@ -2884,7 +2884,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/delete_files": { @@ -2932,7 +2932,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/files": { @@ -2969,7 +2969,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/{name}/invite": { @@ -3402,7 +3402,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/invitations/list_sent": { @@ -3422,7 +3422,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/invitations/update/{inv_id}": { @@ -3494,7 +3494,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/invitations/accept": { @@ -3627,7 +3627,7 @@ "in": "query" } ], - "description": "\nList shared vfolders.\n\nNot available for group vfolders.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nList shared vfolders.\n\nNot available for group vfolders.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "post": { "operationId": "folders.update_shared_vfolder", @@ -3743,7 +3743,7 @@ "in": "query" } ], - "description": "\nReturn the contents of `/etc/fstab` file.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\nReturn the contents of `/etc/fstab` file.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/_/mounts": { @@ -3763,7 +3763,7 @@ } ], "parameters": [], - "description": "\nList all mounted vfolder hosts in vfroot.\n\nAll mounted hosts from connected (ALIVE) agents are also gathered.\nGenerally, agents should be configured to have same hosts structure,\nbut newly introduced one may not.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\nList all mounted vfolder hosts in vfroot.\n\nAll mounted hosts from connected (ALIVE) agents are also gathered.\nGenerally, agents should be configured to have same hosts structure,\nbut newly introduced one may not.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" }, "post": { "operationId": "folders.mount_host", @@ -4001,7 +4001,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "post": { "operationId": "folders.update_quota", @@ -4086,7 +4086,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/folders/_/used-bytes": { @@ -4124,7 +4124,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "//graphql": { @@ -4312,7 +4312,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "post": { "operationId": "services.create", @@ -4409,7 +4409,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/services/{service_id}": { @@ -4445,7 +4445,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "services.delete", @@ -4479,7 +4479,7 @@ } } ], - "description": "\nRemoves model service (and inference sessions for the service also).\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nRemoves model service (and inference sessions for the service also).\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/services/{service_id}/errors": { @@ -4515,7 +4515,7 @@ } } ], - "description": "\nList errors raised while trying to create the inference sessions. Backend.AI will\nstop trying to create an inference session for the model service if six (6) error stacks\nup. The only way to clear the error and retry spawning session is to call\n`clear_error` (POST /services/{service_id}/errors/clear) API.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nList errors raised while trying to create the inference sessions. Backend.AI will\nstop trying to create an inference session for the model service if six (6) error stacks\nup. The only way to clear the error and retry spawning session is to call\n`clear_error` (POST /services/{service_id}/errors/clear) API.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/services/{service_id}/errors/clear": { @@ -4544,7 +4544,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/services/{service_id}/scale": { @@ -4589,7 +4589,7 @@ } } ], - "description": "\nUpdates ideal inference session count manually. Based on the difference of this number,\ninference sessions will be created or removed automatically.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nUpdates ideal inference session count manually. Based on the difference of this number,\ninference sessions will be created or removed automatically.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/services/{service_id}/sync": { @@ -4625,7 +4625,7 @@ } } ], - "description": "\nForce syncs up-to-date model service information with AppProxy.\nIn normal situations this will be automatically handled by Backend.AI schedulers,\nbut this API is left open in case of unexpected restart of AppProxy process.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nForce syncs up-to-date model service information with AppProxy.\nIn normal situations this will be automatically handled by Backend.AI schedulers,\nbut this API is left open in case of unexpected restart of AppProxy process.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/services/{service_id}/routings/{route_id}": { @@ -4678,7 +4678,7 @@ } } ], - "description": "\nUpdates traffic bias of specific route.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nUpdates traffic bias of specific route.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "services.delete_route", @@ -4720,7 +4720,7 @@ } } ], - "description": "\nScales down the service by removing specific inference session.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nScales down the service by removing specific inference session.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/services/{service_id}/token": { @@ -4765,7 +4765,7 @@ } } ], - "description": "\nGenerates a token which acts as an API key to authenticate when calling model service endpoint.\nIf both duration and valid_until is not set then the AppProxy will determine appropriate lifetime of the token.\nduration and valid_until can't be both specified.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nGenerates a token which acts as an API key to authenticate when calling model service endpoint.\nIf both duration and valid_until is not set then the AppProxy will determine appropriate lifetime of the token.\nduration and valid_until can't be both specified.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session": { @@ -5381,7 +5381,7 @@ "in": "query" } ], - "description": "\nA quick session-ID matcher API for use with auto-completion in CLI.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nA quick session-ID matcher API for use with auto-completion in CLI.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/_/sync-agent-registry": { @@ -5484,7 +5484,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "patch": { "operationId": "session.restart", @@ -5527,7 +5527,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "session.destroy", @@ -5580,7 +5580,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "post": { "operationId": "session.execute", @@ -5607,7 +5607,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/_/logs": { @@ -5646,7 +5646,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "get": { "operationId": "session.get_task_logs.2", @@ -5674,7 +5674,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/direct-access-info": { @@ -5703,7 +5703,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/logs": { @@ -5741,7 +5741,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/rename": { @@ -5818,7 +5818,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/complete": { @@ -5847,7 +5847,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/shutdown-service": { @@ -5894,7 +5894,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/upload": { @@ -5923,7 +5923,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/download": { @@ -5995,7 +5995,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/download_single": { @@ -6064,7 +6064,7 @@ } } ], - "description": "\nDownload a single file from the scratch root. Only for small files.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nDownload a single file from the scratch root. Only for small files.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/files": { @@ -6093,7 +6093,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/start-service": { @@ -6154,7 +6154,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/session/{session_name}/commit": { @@ -6348,7 +6348,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/stream/session/{session_name}/pty": { @@ -6377,7 +6377,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/stream/session/{session_name}/execute": { @@ -6406,7 +6406,7 @@ } } ], - "description": "\nWebSocket-version of gateway.kernel.execute().\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nWebSocket-version of gateway.kernel.execute().\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/stream/session/{session_name}/apps": { @@ -6435,7 +6435,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/stream/session/{session_name}/httpproxy": { @@ -6498,7 +6498,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/stream/session/{session_name}/tcpproxy": { @@ -6561,7 +6561,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/manager/status": { @@ -6884,7 +6884,7 @@ } }, "parameters": [], - "description": "\nReturns the list of all resource presets in the current scaling group,\nwith additional information including allocatability of each preset,\namount of total remaining resources, and the current keypair resource limits.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nReturns the list of all resource presets in the current scaling group,\nwith additional information including allocatability of each preset,\namount of total remaining resources, and the current keypair resource limits.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/recalculate-usage": { @@ -6904,7 +6904,7 @@ } ], "parameters": [], - "description": "\nUpdate `keypair_resource_usages` in redis and `agents.c.occupied_slots`.\n\nThose two values are sometimes out of sync. In that case, calling this API\nre-calculates the values for running containers and updates them in DB.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\nUpdate `keypair_resource_usages` in redis and `agents.c.occupied_slots`.\n\nThose two values are sometimes out of sync. In that case, calling this API\nre-calculates the values for running containers and updates them in DB.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/usage/month": { @@ -6945,7 +6945,7 @@ "in": "query" } ], - "description": "\nReturn usage statistics of terminated containers for a specified month.\nThe date/time comparison is done using the configured timezone.\n\n:param group_ids: If not None, query containers only in those groups.\n:param month: The year-month to query usage statistics. ex) \"202006\" to query for Jun 2020\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\nReturn usage statistics of terminated containers for a specified month.\nThe date/time comparison is done using the configured timezone.\n\n:param group_ids: If not None, query containers only in those groups.\n:param month: The year-month to query usage statistics. ex) \"202006\" to query for Jun 2020\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/usage/period": { @@ -6992,7 +6992,7 @@ "in": "query" } ], - "description": "\nReturn usage statistics of terminated containers belonged to the given group for a specified\nperiod in dates.\nThe date/time comparison is done using the configured timezone.\n\n:param project_id: If not None, query containers only in the project.\n:param start_date str: \"yyyymmdd\" format.\n:param end_date str: \"yyyymmdd\" format.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\nReturn usage statistics of terminated containers belonged to the given group for a specified\nperiod in dates.\nThe date/time comparison is done using the configured timezone.\n\n:param project_id: If not None, query containers only in the project.\n:param start_date str: \"yyyymmdd\" format.\n:param end_date str: \"yyyymmdd\" format.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/stats/user/month": { @@ -7012,7 +7012,7 @@ } ], "parameters": [], - "description": "\nReturn time-binned (15 min) stats for terminated user sessions\nover last 30 days.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\nReturn time-binned (15 min) stats for terminated user sessions\nover last 30 days.\n\n\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/stats/admin/month": { @@ -7032,7 +7032,7 @@ } ], "parameters": [], - "description": "\nReturn time-binned (15 min) stats for all terminated sessions\nover last 30 days.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\nReturn time-binned (15 min) stats for all terminated sessions\nover last 30 days.\n\n\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/watcher": { @@ -7061,7 +7061,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/watcher/agent/start": { @@ -7099,7 +7099,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/watcher/agent/stop": { @@ -7137,7 +7137,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/resource/watcher/agent/restart": { @@ -7175,7 +7175,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: RUNNING\n" } }, "/scaling-groups": { @@ -7212,7 +7212,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/scaling-groups/{scaling_group}/wsproxy-version": { @@ -7257,7 +7257,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/template/cluster": { @@ -7308,7 +7308,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "get": { "operationId": "template/cluster.list_template", @@ -7351,7 +7351,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/template/cluster/{template_id}": { @@ -7401,7 +7401,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "put": { "operationId": "template/cluster.put", @@ -7449,7 +7449,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "template/cluster.delete", @@ -7484,7 +7484,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/template/session": { @@ -7535,7 +7535,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "get": { "operationId": "template/session.list_template", @@ -7578,7 +7578,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/template/session/{template_id}": { @@ -7628,7 +7628,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "put": { "operationId": "template/session.put", @@ -7686,7 +7686,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "template/session.delete", @@ -7721,7 +7721,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/user-config/dotfiles": { @@ -7771,7 +7771,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "get": { "operationId": "user-config.list_or_get", @@ -7806,7 +7806,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "patch": { "operationId": "user-config.update", @@ -7854,7 +7854,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "user-config.delete", @@ -7889,7 +7889,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/user-config/bootstrap-script": { @@ -7927,7 +7927,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "get": { "operationId": "user-config.get_bootstrap_script", @@ -7945,7 +7945,7 @@ } ], "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/domain-config/dotfiles": { @@ -7996,7 +7996,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: RUNNING\n" }, "get": { "operationId": "domain-config.list_or_get", @@ -8031,7 +8031,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "patch": { "operationId": "domain-config.update", @@ -8080,7 +8080,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "domain-config.delete", @@ -8115,7 +8115,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: RUNNING\n" } }, "/group-config/dotfiles": { @@ -8177,7 +8177,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: RUNNING\n" }, "get": { "operationId": "group-config.list_or_get", @@ -8228,7 +8228,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "patch": { "operationId": "group-config.update", @@ -8288,7 +8288,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: RUNNING\n" }, "delete": { "operationId": "group-config.delete", @@ -8339,7 +8339,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* Admin privilege required.\n* Manager status required: RUNNING\n" } }, "/logs/error": { @@ -8411,7 +8411,7 @@ } }, "parameters": [], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" }, "get": { "operationId": "logs/error.list_logs", @@ -8456,7 +8456,7 @@ "in": "query" } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, "/logs/error/{log_id}/clear": { @@ -8485,7 +8485,7 @@ } } ], - "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: FROZEN\n" + "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } } }