共用方式為

Restorable Sql Databases - List

  • 參考
服務:
Cosmos DB Resource Provider
API 版本:
2024-11-15

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

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

URI 參數

名稱 位於 必要 類型 Description
instanceId
 path True

string

可還原資料庫帳戶的instanceId GUID。
location
 path True

string

Cosmos DB 區域，單字與每個單字大寫之間的空格。
subscriptionId
 path True

string

目標訂用帳戶的標識碼。
api-version
 query True

string

要用於這項作業的 API 版本。

回應

名稱 類型 Description
200 OK

RestorableSqlDatabasesListResult

作業已順利完成。
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 模擬您的用戶帳戶

範例

CosmosDBRestorableSqlDatabaseList

範例要求

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

範例回覆

狀態碼:
200 
{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "operationType": "Create",
          "canUndelete": "invalid",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/"
          }
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/",
            "_ts": 1599075903
          },
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "properties": {
        "resource": {
          "_rid": "aXFqUQAAAA==",
          "eventTimestamp": "2020-09-02T19:53:15Z",
          "ownerId": "Database2",
          "ownerResourceId": "0SziSg==",
          "database": {
            "id": "Database2",
            "_rid": "0SziSg==",
            "_self": "dbs/0SziSg==/",
            "_etag": "\"0000ca0a-0000-0700-0000-5f4ff82b0000\"",
            "_colls": "colls/",
            "_users": "users/"
          },
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    }
  ]
}

定義

名稱 Description
CloudError

來自服務的錯誤回應。
CreateMode

列舉，表示帳戶建立模式。
Database

Cosmos DB SQL 資料庫資源物件
ErrorResponse

錯誤回應。
OperationType

列舉，表示事件的作業類型。
Resource

Azure Cosmos DB SQL 資料庫事件的資源
ResourceRestoreParameters

用來指出還原相關信息的參數。
RestorableSqlDatabaseGetResult

Azure Cosmos DB SQL 資料庫事件
RestorableSqlDatabasesListResult

列出作業回應，其中包含 SQL 資料庫事件及其屬性。

CloudError

來自服務的錯誤回應。

名稱 類型 Description
error

ErrorResponse

錯誤回應。

CreateMode

列舉，表示帳戶建立模式。

名稱 類型 Description
Default

string

Restore

string

Database

Cosmos DB SQL 資料庫資源物件

名稱 類型 預設值 Description
_colls

string

系統產生的屬性，指定集合資源的可尋址路徑。
_etag

string

系統產生的屬性，表示開放式並行控制所需的資源 etag。
_rid

string

系統產生的屬性。 唯一標識碼。
_self

string

系統產生的屬性，指定資料庫資源的可尋址路徑。
_ts

number

系統產生的屬性，表示資源上次更新的時間戳。
_users

string

系統產生的屬性，指定用戶資源的可尋址路徑。
createMode

CreateMode

Default

列舉，表示資源建立模式。
id

string

Cosmos DB SQL 資料庫的名稱
restoreParameters

ResourceRestoreParameters

用來指出還原相關信息的參數

ErrorResponse

錯誤回應。

名稱 類型 Description
code

string

錯誤碼。
message

string

錯誤訊息，指出作業失敗的原因。

OperationType

列舉，表示事件的作業類型。

名稱 類型 Description
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

Resource

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

名稱 類型 Description
_rid

string

系統產生的屬性。 唯一標識碼。
canUndelete

string

這個資料庫的狀態，用來識別此資料庫是否可在相同帳戶中還原。
canUndeleteReason

string

無法在同一個帳戶中還原此資料庫的原因。
database

Database

Cosmos DB SQL 資料庫資源物件
eventTimestamp

string

發生此資料庫事件的時間。
operationType

OperationType

這個資料庫事件的作業類型。
ownerId

string

SQL 資料庫的名稱。
ownerResourceId

string

SQL 資料庫的資源識別碼。

ResourceRestoreParameters

用來指出還原相關信息的參數。

名稱 類型 Description
restoreSource

string

必須起始還原的可還原資料庫帳戶標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc

string

帳戶必須還原的時間（ISO-8601 格式）。
restoreWithTtlDisabled

boolean

指定還原的帳戶是否會在成功還原時停用時間To-Live。

RestorableSqlDatabaseGetResult

Azure Cosmos DB SQL 資料庫事件

名稱 類型 Description
id

string

ARM 資源的唯一資源標識碼。
name

string

ARM 資源的名稱。
properties.resource

Resource

Azure Cosmos DB SQL 資料庫事件的資源
type

string

Azure 資源的類型。

RestorableSqlDatabasesListResult

列出作業回應，其中包含 SQL 資料庫事件及其屬性。

名稱 類型 Description
value

RestorableSqlDatabaseGetResult[]

SQL 資料庫事件及其屬性的清單。