Restorable Gremlin Databases - List

服務:

Cosmos DB Resource Provider

API 版本:

2026-03-15

顯示在可還原帳戶下所有 Azure Cosmos DB Gremlin 資料庫上完成之所有變動的事件摘要。 這有助於在意外刪除資料庫以取得刪除時間的情況下。 此 API 需要 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' 權限

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinDatabases?api-version=2026-03-15

URI 參數

名稱	位於	必要	類型	Description
instanceId	path	True	string	可還原資料庫帳戶的 instanceId GUID。
location	path	True	string	Cosmos DB 區域，單字之間有空格，每個單字都大寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	RestorableGremlinDatabasesListResult	Azure 運作順利完成。
Other Status Codes	CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	冒用您的使用者帳戶

範例

CosmosDBRestorableGremlinDatabaseList

範例要求

HTTP

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinDatabases?api-version=2026-03-15

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_restorable_gremlin_database_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.restorable_gremlin_databases.list(
        location="WestUS",
        instance_id="d9b26648-2f53-4541-b3d8-3044f4f9810d",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2026-03-15/CosmosDBRestorableGremlinDatabaseList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

200

{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableGremlinDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "PD5DALigDgw=",
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "PD5DALigDgw=",
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    }
  ]
}

定義

名稱	Description
CloudError	來自服務的錯誤回應。
ErrorResponse	錯誤回應。
OperationType	列舉，以指出事件的作業類型。
RestorableGremlinDatabaseGetResult	Azure Cosmos DB Gremlin 資料庫事件
RestorableGremlinDatabasePropertiesResource	Azure Cosmos DB Gremlin 資料庫事件的資源
RestorableGremlinDatabasesListResult	List 作業回應，其中包含 Gremlin 資料庫事件及其屬性。

CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	ErrorResponse	錯誤回應。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息，指出作業失敗的原因。

OperationType

列舉型別

列舉，以指出事件的作業類型。

值	Description
Create
Replace
Delete
Recreate
SystemOperation

RestorableGremlinDatabaseGetResult

Object

Azure Cosmos DB Gremlin 資料庫事件

名稱	類型	Description
id	string	ARM 資源的唯一資源標識碼。
name	string	ARM 資源的名稱。
properties.resource	RestorableGremlinDatabasePropertiesResource	Azure Cosmos DB Gremlin 資料庫事件的資源
type	string	Azure 資源的類型。

RestorableGremlinDatabasePropertiesResource

Object

Azure Cosmos DB Gremlin 資料庫事件的資源

名稱	類型	Description
_rid	string	系統產生的屬性。 唯一識別碼。
canUndelete	string	這個資料庫的狀態，用來識別此資料庫是否可在相同帳戶中還原。
canUndeleteReason	string	無法在同一個帳戶中還原此資料庫的原因。
eventTimestamp	string	發生此資料庫事件的時間。
operationType	OperationType	此資料庫事件的作業類型。
ownerId	string	此 Gremlin 資料庫的名稱。
ownerResourceId	string	此 Gremlin 資料庫的資源識別碼。

RestorableGremlinDatabasesListResult

Object

List 作業回應，其中包含 Gremlin 資料庫事件及其屬性。

名稱	類型	Description
nextLink	string
value	RestorableGremlinDatabaseGetResult[]	Gremlin 資料庫事件及其屬性的清單。