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

Restorable Sql Databases - List

  • Ссылка
Служба:
Cosmos DB Resource Provider
Версия API:
2024-11-15

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

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

Параметры URI

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

string

ИДЕНТИФИКАТОР GUID экземпляра учетной записи базы данных, допускающего восстановление.
location
 path True

string

Регион Cosmos DB с пробелами между словами и каждой прописной буквой слова.
subscriptionId
 path True

string

minLength: 1

Идентификатор целевой подписки.
api-version
 query True

string

minLength: 1

Версия 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-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"
        }
      }
    }
  ]
}

Определения

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

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

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

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

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

Перечисление, указывающее тип операции события.
Resource

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

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

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

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

CloudError

Object

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

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

ErrorResponse

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

CreateMode

Перечисление

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

Значение Описание
Default
Restore

Database

Object

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

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

string

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

string

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

string

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

string

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

number

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

string

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

CreateMode

Default

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

string

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

ResourceRestoreParameters

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

ErrorResponse

Object

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

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

string

Код ошибки.
message

string

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

OperationType

Перечисление

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

Значение Описание
Create
Delete
Recreate
Replace
SystemOperation

Resource

Object

Ресурс события базы данных 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

Object

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

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

string

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

string (date-time)

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

boolean

Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении.

RestorableSqlDatabaseGetResult

Object

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

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

string

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

string

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

Resource

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

string

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

RestorableSqlDatabasesListResult

Object

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

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

RestorableSqlDatabaseGetResult[]

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