Consulta de conexões hospedadas de um locatário
Função
Essa API é usada para consultar conexões hospedadas criadas por parceiros.
URI
GET /v3/{project_id}/dcaas/hosted-connects
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
Especifica o ID do projeto. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
limit |
Não |
Integer |
Especifica o número de registros retornados em cada página. Intervalo de valores: 1 a 2000 Mínimo: 1 Máximo: 2000 Padrão: 2000 |
|
marker |
Não |
String |
Especifica o ID do último registro de recurso na página anterior. Se este parâmetro for deixado em branco, a primeira página será consultada. Este parâmetro deve ser usado junto com limit. Mínimo: 0 Máximo: 36 |
|
fields |
Não |
Array |
Especifica a lista de campos a serem exibidos. |
|
sort_dir |
Não |
Array |
Especifica a ordem de classificação dos resultados retornados, que pode ser asc (ordem crescente) ou desc (ordem decrescente). O valor padrão é asc. |
|
sort_key |
Não |
String |
Especifica o campo de classificação. Padrão: created_at Mínimo: 0 Máximo: 36 |
|
hosting_id |
Não |
Array |
Especifica o ID de conexão de operações pela qual as conexões hospedadas são filtradas. |
|
id |
Não |
Array |
Especifica o ID do recurso pelo qual as instâncias são filtradas. |
|
name |
Não |
Array |
Especifica o nome do recurso pelo qual as instâncias são filtradas. Você pode especificar vários nomes. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Especifica o token do usuário. Para obter o token, consulte a seção "Obtenção do token do usuário" na Referência de API do Identity and Access Management. O token é o valor de X-Subject-Token no cabeçalho de resposta. Mínimo: 0 Máximo: 10240 |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
request_id |
String |
Especifica o ID da solicitação da operação atual. |
|
hosted_connects |
Array of HostedDirectConnect objects |
Especifica os parâmetros para criar uma conexão hospedada. |
|
page_info |
PageInfo object |
Especifica as informações de consulta de paginação. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
Especifica o ID da conexão hospedada. Mínimo: 36 Máximo: 36 |
|
tenant_id |
String |
Especifica o ID do projeto ao qual a instância pertence. |
|
name |
String |
Especifica o nome da conexão. Mínimo: 0 Máximo: 64 |
|
description |
String |
Fornece informações suplementares sobre a conexão. Mínimo: 0 Máximo: 128 |
|
bandwidth |
Integer |
Especifica a largura de banda da conexão em Mbit/s. Mínimo: 2 Máximo: 400000 |
|
location |
String |
Especifica informações sobre o local da Direct Connect. Mínimo: 0 Máximo: 255 |
|
peer_location |
String |
Especifica o local do recurso local na outra extremidade da conexão, específico para o nome da rua ou do data center. Mínimo: 0 Máximo: 255 |
|
hosting_id |
String |
Especifica o ID da conexão de operações na qual a conexão hospedada é criada. |
|
provider |
String |
Especifica o provedor da linha alugada. |
|
admin_state_up |
Boolean |
Especifica o status administrativo, que pode ser true ou false. Padrão: true |
|
vlan |
Integer |
Especifica a VLAN pré-alocada à conexão hospedada. Mínimo: 0 Máximo: 3999 |
|
status |
String |
Especifica o status do gateway virtual. O valor pode ser ACTIVE, ERROR, PENDING_CREATE ou PENDING_UPDATE ACTIVE: o gateway virtual é normal. ERROR: o gateway virtual é anormal. PENDING_CREATE: o gateway virtual está sendo criado. PENDING_UPDATE: o gateway virtual está sendo atualizado. Valores de enumeração:
|
|
apply_time |
String |
Especifica quando a conexão foi solicitada. |
|
create_time |
String |
Especifica quando a conexão foi criada. |
|
provider_status |
String |
Especifica o status da linha alugada da transportadora. O status pode ser ACTIVE ou DOWN. Valores de enumeração:
|
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
previous_marker |
String |
Especifica o marcador da página anterior. O valor é o UUID do recurso. Mínimo: 0 Máximo: 36 |
|
current_count |
Integer |
Especifica o número de recursos na lista atual. Mínimo: 0 Máximo: 2000 |
|
next_marker |
String |
Especifica o marcador da próxima página. O valor é o UUID do recurso. Se o valor estiver vazio, o recurso está na última página. Mínimo: 0 Máximo: 36 |
Exemplos de solicitações
Consulta da lista de conexões hospedadas
POST https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects
Exemplo de respostas
Código de status: 200
OK
{
"request_id" : "a59a3776faa1d055f8124dc7b0977a90",
"hosted_connects" : [ {
"id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6",
"name" : "client-dc-faf1",
"description" : "connect to beijing",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"hosting_id" : "2cfb53be-b05f-40d5-a2f8-3a59ac383836",
"vlan" : 441,
"bandwidth" : 10,
"location" : "hangzhou",
"peer_location" : "",
"provider" : "client-dc-faf1%20\n\n",
"provider_status" : "ACTIVE",
"status" : "ACTIVE",
"apply_time" : "2022-07-13T08:25:38.000Z",
"admin_state_up" : true,
"create_time" : "2022-07-13T08:25:38.000Z"
} ]
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
OK |
Códigos de erro
Consulte Códigos de erro.