Consulta da lista de conexões
Função
Essa API é usada para consultar todas as conexões diretas criadas por um locatário.
URI
GET /v3/{project_id}/dcaas/direct-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_key |
Não |
String |
Especifica o campo de classificação. Padrão: created_at Mínimo: 0 Máximo: 36 |
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. |
hosting_id |
Não |
Array |
Especifica o ID de conexão de operações pela qual as conexões hospedadas são filtradas. |
enterprise_project_id |
Não |
Array |
Especifica o ID do projeto empresarial pela qual as redes centrais 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. |
direct_connects |
Array of DirectConnect objects |
Especifica os parâmetros para a criação de uma conexão. |
page_info |
PageInfo object |
Especifica as informações de consulta de paginação. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
Especifica o ID de conexão. |
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 |
port_type |
String |
Especifica o tipo de porta usada pela conexão. O valor pode ser 1G, 10G, 40G ou 100G. Valores de enumeração:
|
bandwidth |
Integer |
Especifica a largura de banda da conexão em Mbit/s. Mínimo: 2 Máximo: 100000 |
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 |
device_id |
String |
Especifica o ID do dispositivo conectado à conexão. Mínimo: 0 Máximo: 36 |
type |
String |
Especifica o tipo de conexão, que pode ser standard, hosting e hosted. Padrão: standard Valores de enumeração:
|
hosting_id |
String |
Especifica o ID da conexão de operações na qual a conexão hospedada é criada. |
charge_mode |
String |
Especifica o modo de faturamento, que pode ser prepayment, bandwidth ou traffic. Valores de enumeração:
|
provider |
String |
Especifica a operadora da conexão, por exemplo, China Telecom, China Unicom, China Mobile e outras operadoras dentro e fora da China continental. |
admin_state_up |
Boolean |
Especifica o status administrativo, que pode ser true ou false. Padrão: true |
vlan |
Integer |
Especifica a VLAN alocada para a conexão hospedada. Mínimo: 0 Máximo: 3999 |
status |
String |
Especifica o status da conexão, que pode ser ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT ou REJECTED. 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:
|
peer_port_type |
String |
Especifica o tipo de porta de par. |
peer_provider |
String |
Especifica a operadora conectada à conexão. |
order_id |
String |
Especifica o ID do pedido de conexão, que é usado para dar suporte ao faturamento baseado em duração e identificar pedidos do usuário. |
product_id |
String |
Especifica o ID do produto correspondente à ordem da conexão, que é usada para políticas de faturamento personalizadas, como pacotes baseados em duração. |
spec_code |
String |
Especifica as especificações do produto correspondentes à ordem da conexão, que são usadas para políticas de cobrança personalizadas, como pacotes baseados em duração. |
period_type |
Integer |
Especifica se uma conexão em uma ordem especificada é faturada por ano ou por mês. |
period_num |
Integer |
Especifica a duração de serviço necessária de uma conexão anual/mensal. |
vgw_type |
String |
Especifica o tipo de gateway exigido por uma conexão direta. Padrão: default Valores de enumeração:
|
lag_id |
String |
Especifica o ID do LAG ao qual a conexão pertence. |
signed_agreement_status |
String |
Especifica o status de assinatura do contrato da Direct Connect. Valores de enumeração:
|
enterprise_project_id |
String |
Especifica o ID do projeto corporativo ao qual a conexão pertence. Mínimo: 36 Máximo: 36 |
tags |
Array of Tag objects |
Especifica as tags. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
key |
String |
Especifica a chave de tag. A chave pode conter no máximo 36 caracteres Unicode, incluindo letras, dígitos, hifens (-) e sublinhados (_). Mínimo: 0 Máximo: 36 |
value |
String |
Especifica o valor de tag. O valor pode conter no máximo 43 caracteres Unicode, incluindo letras, dígitos, hifens (-) sublinhados (_) e pontos (.). Mínimo: 0 Máximo: 43 |
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
Atualização de uma conexão
GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects
Exemplo de respostas
Código de status: 200
OK
{ "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535", "direct_connects" : [ { "bandwidth" : 100, "create_time" : "2018-10-19 09:53:26.389556", "port_type" : "10G", "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "apply_time" : "2018-10-19 09:53:26.389556", "peer_location" : "", "location" : "Biere", "provider" : "OTC", "type" : "standard", "status" : "BUILD", "description" : "", "provider_status" : "ACTIVE", "order_id" : "", "vlan" : null, "device_id" : "172.16.40.2", "name" : "direct connect1", "admin_state_up" : true, "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f", "hosting_id" : null, "product_id" : "", "charge_mode" : "" } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
Códigos de erro
Consulte Códigos de erro.