Поделиться через


Restorable Sql Databases - List

Отображение веб-канала событий всех изменений, выполненных во всех базах данных SQL Azure Cosmos DB в восстанавливаемой учетной записи. Это помогает в сценарии, когда база данных была случайно удалена, чтобы получить время удаления. Для этого API требуется разрешение Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read

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

Параметры URI

Имя В Обязательно Тип Описание
instanceId
path True

string

Идентификатор GUID instanceId восстанавливаемой учетной записи базы данных.

location
path True

string

Область Cosmos DB с пробелами между словами и каждое слово с прописными буквами.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

RestorableSqlDatabasesListResult

Операция выполнена успешно.

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
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-05-15

Пример ответа

{
  "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"
        }
      }
    }
  ]
}

Определения

Имя Описание
CloudError

Ответ об ошибке от службы.

CreateMode

Перечисление для указания режима создания учетной записи.

Database

Объект ресурса базы данных SQL Cosmos DB

ErrorResponse

Ответ на ошибку.

OperationType

Перечисление для указания типа операции события.

Resource

Ресурс события базы данных SQL Azure Cosmos DB

ResourceRestoreParameters

Параметры, указывающие сведения о восстановлении.

RestorableSqlDatabaseGetResult

Событие базы данных SQL Azure Cosmos DB

RestorableSqlDatabasesListResult

Ответ операции List, содержащий события базы данных SQL и их свойства.

CloudError

Ответ об ошибке от службы.

Имя Тип Описание
error

ErrorResponse

Ответ на ошибку.

CreateMode

Перечисление для указания режима создания учетной записи.

Имя Тип Описание
Default

string

Restore

string

Database

Объект ресурса базы данных SQL Cosmos DB

Имя Тип Default value Описание
_colls

string

Созданное системой свойство, указывающее адресуемый путь к ресурсу коллекций.

_etag

string

Созданное системой свойство, представляющее тег ресурса, необходимый для управления оптимистическим параллелизмом.

_rid

string

Созданное системой свойство. Уникальный идентификатор.

_self

string

Созданное системой свойство, указывающее адресуемый путь к ресурсу базы данных.

_ts

number

Созданное системой свойство, обозначающее метку времени последнего обновления ресурса.

_users

string

Созданное системой свойство, указывающее адресуемый путь к ресурсу users.

createMode

CreateMode

Default

Перечисление для указания режима создания ресурса.

id

string

Имя базы данных SQL Cosmos DB

restoreParameters

ResourceRestoreParameters

Параметры для указания сведений о восстановлении

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

OperationType

Перечисление для указания типа операции события.

Имя Тип Описание
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

Resource

Ресурс события базы данных SQL Azure Cosmos DB

Имя Тип Описание
_rid

string

Созданное системой свойство. Уникальный идентификатор.

canUndelete

string

Состояние этой базы данных для определения возможности восстановления этой базы данных в той же учетной записи.

canUndeleteReason

string

Причина, по которой эта база данных не может быть восстановлена в той же учетной записи.

database

Database

Объект ресурса базы данных SQL Cosmos DB

eventTimestamp

string

Время, когда произошло это событие базы данных.

operationType

OperationType

Тип операции этого события базы данных.

ownerId

string

Имя базы данных SQL.

ownerResourceId

string

Идентификатор ресурса базы данных SQL.

ResourceRestoreParameters

Параметры, указывающие сведения о восстановлении.

Имя Тип Описание
restoreSource

string

Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}

restoreTimestampInUtc

string

Время восстановления учетной записи (формат ISO-8601).

RestorableSqlDatabaseGetResult

Событие базы данных SQL Azure Cosmos DB

Имя Тип Описание
id

string

Уникальный идентификатор ресурса ARM.

name

string

Имя ресурса ARM.

properties.resource

Resource

Ресурс события базы данных SQL Azure Cosmos DB

type

string

Тип ресурса Azure.

RestorableSqlDatabasesListResult

Ответ операции List, содержащий события базы данных SQL и их свойства.

Имя Тип Описание
value

RestorableSqlDatabaseGetResult[]

Список событий базы данных SQL и их свойств.