Consulta de um recurso protegível especificado
Função
Esta API é usada para consultar um recurso especificado que pode ser protegido por seu ID.
URI
GET /v3/{project_id}/protectables/{protectable_type}/instances/{instance_id}
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
instance_id | Sim | String | ID do recurso |
project_id | Sim | String | ID do projeto |
protectable_type | Sim | String | Tipo de proteção Valores de enumeração:
|
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de status: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
instance | ProtectablesResp object | Recursos que podem ser protegidos |
Parâmetro | Tipo | Descrição |
|---|---|---|
children | Array of objects | Recurso filho |
detail | Object | Detalhes do recurso |
id | String | id |
name | String | Nome do recurso |
protectable | ProtectableResult object | Se o backup é suportado |
size | Integer | Tamanho do recurso, em GB |
status | String | Status do recurso Valores de enumeração:
|
Tipo | String | Tipo do recurso a ser copiado, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2 |
Parâmetro | Tipo | Descrição |
|---|---|---|
code | String | Código de erro retornado indicando que o backup não é suportado |
reason | String | Motivo pelo qual o backup não é suportado |
result | Boolean | Se o backup é suportado |
vault | VaultGet object | Cofre associado |
message | String | Razão pela qual o recurso não pode ser feito backup. Esse campo é retornado somente se a verificação de proteção do recurso falhar. |
Parâmetro | Tipo | Descrição |
|---|---|---|
billing | Billing object | Informação da operação |
description | String | Descrição do cofre definida pelo usuário Mínimo: 0 Máximo: 255 |
id | String | ID do cofre |
name | String | Nome do cofre Mínimo: 1 Máximo: 64 |
project_id | String | ID do projeto |
provider_id | String | ID do tipo de recurso do cofre |
resources | Array of ResourceResp objects | Recurso |
tags | Array of TagsResp objects | Tag |
enterprise_project_id | String | ID do projeto empresarial. O valor padrão é 0. |
auto_bind | Boolean | Indica se a associação automática está ativada. Seu valor padrão é false (não ativado). |
bind_rules | VaultBindRules object | Regra de associação |
user_id | String | ID do usuário |
created_at | String | Tempo de criação, por exemplo, 2020-02-05T10:38:34.209782 |
auto_expand | Boolean | Se ativar a expansão de capacidade automática para o cofre. Somente os cofres do pagamento por uso suportam a autoexpansão da capacidade. |
smn_notify | Boolean | Função de notificação de exceção Padrão: true |
threshold | Integer | Limite de capacidade do cofre. Se o uso da capacidade do cofre excede este limite, uma notificação de exceção é enviada. Mínimo: 1 Máximo: 100 Padrão: 80 |
updated_at | String | Tempo de atualização, por exemplo, 2020-02-05T10:38:34.209782 |
version | String | Versão |
Parâmetro | Tipo | Descrição |
|---|---|---|
allocated | Integer | Capacidade alocada, em GB. |
charging_mode | String | Modo de cobrança, que pode ser post_paid (pagamento por uso) ou pre_paid (anual/mensal). O valor padrão é post_paid. |
cloud_type | String | Tipo de nuvem, que pode ser public ou hybrid |
consistent_level | String | Especificação do cofre, que pode ser crash_consistent (backup consistente com falhas) ou app_consistent (backup consistente com a aplicação) |
object_type | String | Tipo de objeto, que pode ser server, disk, turbo ou workspace |
order_id | String | ID do pedido |
product_id | String | ID do produto |
protect_type | String | Tipo de proteção, que pode ser backup ou replication |
size | Integer | Capacidade, em GB Mínimo: 1 Máximo: 10485760 |
spec_code | String | Código de especificação. Cofre de backup do servidor: vault.backup.server.normal; Cofre de backup em disco: vault.backup.volume.normal; Cofre de backup do sistema de arquivos: vault.backup.turbo.normal |
status | String | Estado do cofre Valores de enumeração:
|
storage_unit | String | Nome do bucket para o cofre |
used | Integer | Capacidade utilizada, em MB. |
frozen_scene | String | Cenário quando uma conta é congelada |
Parâmetro | Tipo | Descrição |
|---|---|---|
extra_info | ResourceExtraInfo object | Informações adicionais do recurso |
id | String | ID do recurso a ser copiado |
name | String | Nome do recurso a ser copiado Mínimo: 0 Máximo: 255 |
protect_status | String | Status da proteção Valores de enumeração:
|
size | Integer | Capacidade alocada para os recursos associados, em GB |
type | String | Tipo do recurso a ser copiado, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2 |
backup_size | Integer | Tamanho do backup |
backup_count | Integer | Número de backups |
Parâmetro | Tipo | Descrição |
|---|---|---|
exclude_volumes | Array of strings | IDs dos discos dos quais não será feito backup. Este parâmetro é usado quando os servidores são adicionados a um cofre, que inclui todos os discos do servidor. Mas alguns discos não precisam ser copiados. Ou no caso de um servidor ter sido adicionado anteriormente e alguns discos neste servidor não precisarem ser copiados. |
Parâmetro | Tipo | Descrição |
|---|---|---|
key | String | Chave É composta por até 36 caracteres. Não pode ser uma cadeia vazia. Pode conter apenas caracteres chineses, letras, dígitos, hifens (-) e sublinhados (_). |
values | String | Lista de valores É composta por até 43 caracteres. Pode ser uma cadeia vazia. Pode conter apenas caracteres chineses, letras, dígitos, hifens (-) e sublinhados (_). |
Parâmetro | Tipo | Descrição |
|---|---|---|
tags | Array of BindRulesTags objects | Filtra recursos associados automaticamente por tag. |
Parâmetro | Tipo | Descrição |
|---|---|---|
key | String | A chave não pode conter caracteres ASCII não imprimíveis (0–31) ou os seguintes caracteres: =*<>,|/ A chave pode conter apenas letras, dígitos, hifens (-) e sublinhados (_). |
value | String | O valor não pode conter caracteres ASCII não imprimíveis (0–31) ou os seguintes caracteres: =*<>,|/ O valor pode conter apenas letras, dígitos, hifens (-) e sublinhados (_). |
Exemplo de solicitações
GET https://{endpoint}/v3/{project_id}/protectables/{protectable_type}/instances/{instance_id} Exemplo de respostas
Código de status: 200
OK
{
"instance" : {
"status" : "ACTIVE",
"children" : [ {
"status" : "in-use",
"name" : "volume-f926-0001",
"detail" : {
"attachments" : [ {
"server_id" : "55ecd8b8-1457-4a2a-a9df-53756a690082",
"attachment_id" : "3b32cb75-bd96-493b-8fb2-13f063c876d5",
"volume_id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99",
"host_name" : null,
"attached_at" : "2019-05-08T06:56:25.891730",
"device" : "/dev/vdb",
"id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99"
} ],
"links" : [ {
"href" : "https://volume.region1.com/v2/3aec9116a6a5487ca14987121d2818fe/volumes/8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99",
"rel" : "self"
}, {
"href" : "https://volume.region1.com/3aec9116a6a5487ca14987121d2818fe/volumes/8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99",
"rel" : "bookmark"
} ],
"availability_zone" : "AZ1",
"os-vol-host-attr:host" : "AZ1.xxxxxx#FusionStorage",
"encrypted" : false,
"updated_at" : "2019-05-08T06:56:26.207240",
"replication_status" : "disabled",
"snapshot_id" : null,
"id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99",
"size" : 10,
"user_id" : "f3d66502790d4ddaadef5056059ed8f4",
"os-vol-tenant-attr:tenant_id" : "3aec9116a6a5487ca14987121d2818fe",
"os-vol-mig-status-attr:migstat" : null,
"metadata" : {
"policy" : "cf3274fc-d23e-4c12-8be7-1e41b3c2faea",
"readonly" : "False",
"attached_mode" : "rw"
},
"status" : "in-use",
"description" : null,
"multiattach" : false,
"source_volid" : null,
"consistencygroup_id" : null,
"os-vol-mig-status-attr:name_id" : null,
"name" : "volume-f926-0001",
"bootable" : "false",
"created_at" : "2019-03-26T09:30:46.783578",
"volume_type" : "SATA",
"shareable" : false
},
"children" : [ ],
"type" : "OS::Cinder::Volume",
"id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99",
"size" : 10
}, {
"status" : "in-use",
"name" : "no_delete_for_cbr_interface-volume-0000",
"detail" : {
"attachments" : [ {
"server_id" : "55ecd8b8-1457-4a2a-a9df-53756a690082",
"attachment_id" : "e16631fa-0522-4ac8-8f78-19db435caf68",
"volume_id" : "13eb535f-8635-4faf-9f08-584d21e78f0a",
"host_name" : null,
"attached_at" : "2019-05-08T06:55:26.563986",
"device" : "/dev/vda",
"id" : "13eb535f-8635-4faf-9f08-584d21e78f0a"
} ],
"links" : [ {
"href" : "https://volume.region1.com/v2/3aec9116a6a5487ca14987121d2818fe/volumes/13eb535f-8635-4faf-9f08-584d21e78f0a",
"rel" : "self"
}, {
"href" : "https://volume.region1.com/3aec9116a6a5487ca14987121d2818fe/volumes/13eb535f-8635-4faf-9f08-584d21e78f0a",
"rel" : "bookmark"
} ],
"availability_zone" : "AZ1",
"os-vol-host-attr:host" : "AZ1.xxxxxx#kvm_fusionstorage",
"encrypted" : false,
"updated_at" : "2019-05-08T08:33:07.855484",
"replication_status" : "disabled",
"snapshot_id" : null,
"id" : "13eb535f-8635-4faf-9f08-584d21e78f0a",
"size" : 40,
"user_id" : "3204777a731c4ebea330350c04f41b92",
"os-vol-tenant-attr:tenant_id" : "3aec9116a6a5487ca14987121d2818fe",
"os-vol-mig-status-attr:migstat" : null,
"metadata" : {
"policy" : "2ecbcffd-08ba-43f7-bf8d-95daba753464",
"readonly" : "False",
"attached_mode" : "rw"
},
"status" : "in-use",
"volume_image_metadata" : {
"container_format" : "bare",
"min_ram" : "0",
"__account_code" : "",
"__os_bit" : "64",
"size" : "2",
"__os_version" : "CentOS 7.2 64bit",
"__backup_id" : "",
"__description" : "",
"__support_diskintensive" : "true",
"disk_format" : "vhd",
"__isregistered" : "true",
"__image_size" : "3295645696",
"__platform" : "CentOS",
"__root_origin" : "file",
"__originalimagename" : "703eb90a-a65f-4c72-b4c1-f070a55d068b",
"__quick_start" : "true",
"image_name" : "CentOS7.2-cloudinit",
"image_id" : "703eb90a-a65f-4c72-b4c1-f070a55d068b",
"__os_type" : "Linux",
"__image_location" : "172.100.45.130:443:pcsimsf8bd00bf6c304d2e8cf4e2beb0aed702:703eb90a-a65f-4c72-b4c1-f070a55d068b",
"min_disk" : "40",
"__data_origin" : "file,jingxiang:CentOS-7.2-64bit.zvhd2",
"__support_kvm" : "true",
"virtual_env_type" : "FusionCompute",
"__image_source_type" : "uds",
"__support_xen" : "true",
"checksum" : "99914b932bd37a50b983c5e7c90ae93b",
"__imagetype" : "gold",
"__productcode" : ""
},
"description" : null,
"multiattach" : false,
"source_volid" : null,
"consistencygroup_id" : null,
"os-vol-mig-status-attr:name_id" : null,
"name" : "no_delete_for_cbr_interface-volume-0000",
"bootable" : "true",
"created_at" : "2019-05-08T06:54:58.477749",
"volume_type" : "SATA",
"shareable" : false
},
"children" : [ ],
"type" : "OS::Cinder::Volume",
"id" : "13eb535f-8635-4faf-9f08-584d21e78f0a",
"size" : 40
} ],
"protectable" : {
"vault" : null,
"reason" : "",
"code" : "",
"result" : true
},
"name" : "no_delete_for_cbr_interface",
"detail" : {
"OS-EXT-STS:task_state" : null,
"addresses" : {
"94b88790-c906-4450-b7c2-1c2b1ea639bf" : [ {
"OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:9b:9d:af",
"version" : 4,
"addr" : "192.168.1.44",
"OS-EXT-IPS:type" : "fixed"
}, {
"OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:9b:9d:af",
"version" : 4,
"addr" : "100.78.0.199",
"OS-EXT-IPS:type" : "floating"
} ]
},
"links" : [ {
"href" : "https://compute.region1.com/v2.1/3aec9116a6a5487ca14987121d2818fe/servers/55ecd8b8-1457-4a2a-a9df-53756a690082",
"rel" : "self"
}, {
"href" : "https://compute.region1.com/3aec9116a6a5487ca14987121d2818fe/servers/55ecd8b8-1457-4a2a-a9df-53756a690082",
"rel" : "bookmark"
} ],
"image" : "",
"OS-EXT-STS:vm_state" : "active",
"OS-EXT-SRV-ATTR:instance_name" : "instance-0004456e",
"OS-SRV-USG:launched_at" : "2019-05-08T06:55:38.000000",
"flavor" : {
"id" : "s3.small.1",
"links" : [ {
"href" : "https://compute.region1.com/3aec9116a6a5487ca14987121d2818fe/flavors/s3.small.1",
"rel" : "bookmark"
} ]
},
"id" : "55ecd8b8-1457-4a2a-a9df-53756a690082",
"security_groups" : [ {
"name" : "default"
} ],
"user_id" : "f3d66502790d4ddaadef5056059ed8f4",
"OS-DCF:diskConfig" : "MANUAL",
"accessIPv4" : "",
"accessIPv6" : "",
"progress" : 0,
"OS-EXT-STS:power_state" : 1,
"OS-EXT-AZ:availability_zone" : "AZ1",
"config_drive" : "",
"status" : "ACTIVE",
"updated" : "2019-05-08T06:57:02Z",
"hostId" : "179f22cafe6b951921bd6deb3b13a978df620427fb37bbb7c619de98",
"OS-EXT-SRV-ATTR:host" : "AZ1.xxxxxx",
"OS-SRV-USG:terminated_at" : null,
"key_name" : null,
"OS-EXT-SRV-ATTR:hypervisor_hostname" : "nova003@36",
"name" : "no_delete_for_cbr_interface",
"created" : "2019-05-08T06:55:22Z",
"tenant_id" : "3aec9116a6a5487ca14987121d2818fe",
"os-extended-volumes:volumes_attached" : [ {
"id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99"
}, {
"id" : "13eb535f-8635-4faf-9f08-584d21e78f0a"
} ],
"metadata" : {
"metering.image_id" : "703eb90a-a65f-4c72-b4c1-f070a55d068b",
"metering.imagetype" : "gold",
"metering.resourcespeccode" : "s3.small.1.linux",
"metering.cloudServiceType" : "sys.service.type.ec2",
"virtual_env_type" : "FusionCompute",
"image_name" : "CentOS7.2-cloudinit",
"metering.resourcetype" : "1",
"vpc_id" : "94b88790-c906-4450-b7c2-1c2b1ea639bf",
"os_bit" : "64",
"cascaded.instance_extrainfo" : "",
"os_type" : "Linux",
"charging_mode" : "0"
}
},
"type" : "OS::Nova::Server",
"id" : "55ecd8b8-1457-4a2a-a9df-53756a690082",
"size" : 50
}
} Códigos de status
Código de status | Descrição |
|---|---|
200 | OK |
Códigos de erro
Consulte Códigos de erro.

