Связаться с намиПодключиться
Yandex Cloud Backup

Cloud Backup API, REST: Resource.get

Статья создана
Обновлена 4 сентября 2024 г.

Get specific Compute Cloud instance.

HTTP request

GET https://backup.api.cloud.yandex.net/backup/v1/resources/{computeInstanceId}

Path parameters

Parameter Description
computeInstanceId

Required. Compute Cloud instance ID.

The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "resource": {
    "computeInstanceId": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "online": true,
    "enabled": true,
    "status": "string",
    "statusDetails": "string",
    "statusProgress": "string",
    "lastBackupTime": "string",
    "nextBackupTime": "string",
    "resourceId": "string",
    "isActive": true,
    "initStatus": "string",
    "metadata": "string",
    "type": "string"
  }
}
Field Description
resource object

Set of resource parameters.
resource.
computeInstanceId		 string

Compute Cloud instance ID.
resource.
createdAt		 string (date-time)

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
resource.
updatedAt		 string (date-time)

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
resource.
online		 boolean (boolean)

If this field is true, it means that instance is online.
resource.
enabled		 boolean (boolean)

If this field is true, it means that backup is enabled to instance.
resource.
status		 string
  • IDLE: Compute Cloud instance is doing nothing right now.
  • BACKUPING: Compute Cloud instance is currently backing up itself.
  • RECOVERING: Compute Cloud instance is currently recovering itself.
  • FAILED: Compute Cloud instance is in failure state, check content of status_details field for more information.
  • OTHER: Unspecified state, check status_details field for more information.
resource.
statusDetails		 string

If status value is one of OTHER or FAILED, detailed info might be stored here.
resource.
statusProgress		 string (int64)

In case status is one of BACKUPING or RECOVERING, progress value might be found here.
resource.
lastBackupTime		 string (date-time)

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
resource.
nextBackupTime		 string (date-time)

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
resource.
resourceId		 string

Resource ID is used to identify Compute Cloud instance in backup service.
resource.
isActive		 boolean (boolean)

Status is_active shows whether current Compute Cloud instance controls Cloud Backup resource. If status is_active is false it means Compute Cloud instance is not able to manipulate Cloud Backup resource.
resource.
initStatus		 string

Status of resource initialization in cloud backup service.

  • REGISTERING: Registration of instance in cloud backups have started.
  • REGISTRED: Instance is registered in cloud backups.
  • FAILED_REGISTRATION: Instance registration failed.
  • DELETED: Instance is deleted from cloud backup service.
resource.
metadata		 string

Metadata to provide details about instance registration process if status is FAILED_REGISTRATION or REGISTERING
resource.
type		 string

Type of resource. Could be compute VM or baremetal server.

  • COMPUTE: Resource is Compute Cloud VM
  • BMS: Resource is baremetal server
Предыдущая
delete
Следующая
list
В этой статье: