DescribePhysicalConnections - Express Connect: Central de Documentação do Alibaba Cloud

Consulta informações sobre circuitos do Express Connect em uma região especificada.

Descrição da operação

Por padrão, o sistema consulta informações sobre todos os circuitos do Express Connect na região especificada. Você pode usar as opções de filtro fornecidas pela operação DescribePhysicalConnections para consultar informações sobre circuitos do Express Connect específicos. Para as opções de filtro suportadas, consulte a descrição de Key na seção parâmetros da solicitação deste tópico.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

vpc:DescribePhysicalConnections

list

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do circuito do Express Connect. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
PageNumber	integer	Não	O número da página da lista. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor padrão: 10. Valores válidos: 1 a 50.	10
IncludeReservationData	boolean	Não	Especifica se devem ser retornados dados de pedidos que ainda não entraram em vigor. Valores válidos: true: Retorna dados de pedidos que ainda não entraram em vigor. false (padrão): Não retorna dados de pedidos que ainda não entraram em vigor.	false
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação. Gere um valor de parâmetro a partir do seu cliente para garantir a exclusividade em diferentes solicitações. O ClientToken suporta apenas caracteres ASCII.	02fb3da4-130e-11e9-8e44-001
Filter	array<object>	Não	A lista de condições de filtro.
	object	Não	A condição de filtro.
Key	string	Não	A condição de filtro. Valores válidos: PhysicalConnectionId: o ID do circuito do Express Connect. AccessPointId: o ID do ponto de acesso. Type: o tipo de circuito do Express Connect. Esta condição de filtro suporta apenas o valor VPC. LineOperator: a operadora do circuito do Express Connect. Esta condição de filtro suporta os seguintes valores: CT: China Telecom. CU: China Unicom. CM: China Mobile. CO: outras operadoras na China. Equinix: Equinix. Other: outras operadoras fora da China. Spec: a especificação do circuito do Express Connect. Esta condição de filtro suporta os seguintes valores: 1G and below. 10G. 40G. 100G. Nota As especificações 40G e 100G não estão disponíveis por padrão. Apenas usuários que enviaram uma solicitação ao seu gerente de conta e receberam aprovação podem usar esses valores. Status: o status do circuito do Express Connect. Esta condição de filtro suporta os seguintes valores: Initial: aplicação pendente. Approved: aprovado. Allocating: alocando recursos. Allocated: em construção. Confirmed: aguardando confirmação do usuário. Enabled: ativado. Rejected: aplicação negada. Canceled: cancelado. Allocation Failed: falha na alocação de recursos. Terminating: parando. Terminated: parado. Name: o nome do circuito do Express Connect. ProductType: o tipo de circuito. Valores válidos: VirtualPhysicalConnection: circuito do Express Connect compartilhado. PhysicalConnection: circuito do Express Connect dedicado. Você pode especificar até 5 condições de filtro por vez. As condições de filtro têm uma relação AND. Os resultados são retornados apenas quando todas as condições de filtro são atendidas.	Name
Value	array	Não	A lista de valores de filtro.	1
	string	Não	O valor de filtro que corresponde à condição de filtro. Cada condição de filtro suporta até 5 valores de filtro. Vários valores de filtro têm uma relação OR. Um registro é considerado correspondente à condição de filtro se corresponder a qualquer um dos valores de filtro.	nametest
Tags	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag do recurso. Você pode especificar até 20 chaves de tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 64 caracteres e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-). Ela não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceDept
Value	string	Não	O valor da tag do recurso. Você pode especificar até 20 valores de tag. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-). Ele não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceJoshua
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o circuito do Express Connect pertence.	rg-aek2yvwibxr****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	0E6D0EC4-7C91-53E2-9F65-64BF713114B0
PageNumber	integer	O número da página da lista. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página em uma consulta paginada. Valor padrão: 10. Valores válidos: 1 a 50.	10
TotalCount	integer	O número total de entradas retornadas.	1
PhysicalConnectionSet	object
PhysicalConnectionType	array<object>	A lista de circuitos do Express Connect.
	array<object>	Os detalhes do circuito do Express Connect.
Type	string	The type of the Express Connect circuit. Valid values: VPC.	VPC
Status	string	The status of the Express Connect circuit. Valid values: Initial: pending application. Approved: approved. Allocating: allocating resources. Allocated: under construction. Confirmed: pending user confirmation. Enabled: enabled. Rejected: application rejected. Canceled: canceled. Allocation Failed: resource allocation failed. Terminating: terminating. Terminated: terminated.	Enabled
CreationTime	string	The time when the Express Connect circuit was created.	2021-08-24T07:30:58Z
AdLocation	string	The location of the access point where the Express Connect circuit access device is deployed.	浙江省杭州市XX区XX镇XX路10号
ReservationActiveTime	string	The effective period of the order that has not taken effect.	2022-02-25T11:01:04Z
ReservationOrderType	string	The type of the order that has not taken effect. Valid values: RENEW, which indicates a renewal order.	RENEW
PortNumber	string	The port number of the Express Connect circuit access device.	1/1/1
Spec	string	The specification of the Express Connect circuit. Unit: G indicates Gbit/s.	10G
ChargeType	string	The billing method of the Express Connect circuit. Valid values: Prepaid, which indicates subscription.	Prepaid
ReservationInternetChargeType	string	The billing type of the order that has not taken effect. Valid values: PayByBandwidth, which indicates pay-by-bandwidth.	PayByBandwidth
Description	string	The description of the Express Connect circuit.	desctest
Bandwidth	integer	The bandwidth of the Express Connect circuit. Unit: Mbit/s.	10
EnabledTime	string	The time when the Express Connect circuit was enabled.	2021-08-24T07:33:18Z
LineOperator	string	The carrier that provides the physical line for the Express Connect circuit. Valid values: CT: China Telecom. CU: China Unicom. CM: China Mobile. CO: other carriers in China. Equinix: Equinix. Other: other carriers outside China.	CT
PeerLocation	string	The geographic location of the on-premises data center.	浙江省杭州市XX区XX镇XX路XX号
RedundantPhysicalConnectionId	string	The ID of the redundant Express Connect circuit.	pc-119mfjzm****
Name	string	The name of the Express Connect circuit.	nametest
CircuitCode	string	The circuit code provided by the carrier for the Express Connect circuit.	longtel001
EndTime	string	The expiration time of the Express Connect circuit.	2022-04-24T16:00:00Z
PortType	string	The port type of the Express Connect circuit access device. Valid values: 100Base-T: 100M Ethernet port. 1000Base-T: 1 GE electrical port. 1000Base-LX: GE single-mode optical port (10 km). 10GBase-T: 10 GE electrical port. 10GBase-LR: 10 GE single-mode optical port (10 km). 40GBase-LR: 40 GE single-mode optical port. 100GBase-LR: 100 GE single-mode optical port. Nota 40GBase-LR and 100GBase-LR ports are created based on the actual port availability in the backend. Contact your account manager for port availability details.	10GBase-LR
BusinessStatus	string	The business status of the Express Connect circuit. Valid values: Normal: enabled. FinancialLocked: locked due to overdue payment. SecurityLocked: locked for security reasons.	Normal
LoaStatus	string	The status of the Letter of Authorization (LOA). Valid values: Applying: LOA application in progress. Accept: LOA application approved. Available: LOA available. Rejected: LOA application rejected. Completing: circuit construction in progress. Complete: circuit construction completed. Deleted: LOA deleted.	Available
AccessPointId	string	The ID of the access point for the Express Connect circuit.	ap-cn-hangzhou-finance-yh-E
AccessPointType	string	The type of the access point for the Express Connect circuit.	VPC
HasReservationData	string	Indicates whether the response includes data of orders that have not taken effect. Valid values: true: The response includes data of orders that have not taken effect. false: The response does not include data of orders that have not taken effect.	false
PhysicalConnectionId	string	The instance ID of the Express Connect circuit.	pc-bp1ciz7ekd2grn1as****
ProductType	string	The type of the Express Connect circuit. Valid values: VirtualPhysicalConnection: shared Express Connect circuit. PhysicalConnection: dedicated Express Connect circuit.	PhysicalConnection
VirtualPhysicalConnectionCount	integer	The number of shared Express Connect circuits created under the current Express Connect circuit.	0
ParentPhysicalConnectionId	string	The instance ID of the Express Connect circuit associated with the shared Express Connect circuits.	pc-bp1ciz7ekd2grn1as****
ParentPhysicalConnectionAliUid	integer	The Alibaba Cloud account ID that owns the Express Connect circuit associated with the shared Express Connect circuits.	132193271328****
VlanId	string	The VLAN ID of the shared Express Connect circuits.	10
OrderMode	string	The payer of the shared Express Connect circuits. Valid values: PayByPhysicalConnectionOwner: The partner pays. PayByVirtualPhysicalConnectionOwner: The tenant pays.	PayByPhysicalConnectionOwner
VpconnStatus	string	The business status of the shared Express Connect circuits. Valid values: Confirmed: The shared Express Connect circuits have been accepted. UnConfirmed: The shared Express Connect circuits have not been accepted. Deleted: The shared Express Connect circuits have been deleted.	Confirmed
ExpectSpec	string	The expected bandwidth of the shared Express Connect circuits. The expected bandwidth takes effect after payment is completed. Unit: M indicates Mbit/s, G indicates Gbit/s.	50M
ResourceGroupId	string	The resource group ID.	rg-acfmwu3k52p****
AdDetailLocation	string	The information about the data center and rack.	浙江省杭州市XX区XX镇XX路10号, XX机房, ET135ET135-XX-2包间, JXX机柜, position30
Tags	object
tags	array<object>	The list of tags.
	object	The list of tags.
Key	string	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceDept
Value	string	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceJoshua
QosId	string	The instance ID of the QoS policy.	qos-bp10s3szn8rgnxuw7****
OpticalModuleModel	string
MacsecKeys	object
MacsecKey	array<object>
	object
CipherSuite	string
Ckn	string
Cak	string
StartOn	string
Status	string

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0E6D0EC4-7C91-53E2-9F65-64BF713114B0",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "PhysicalConnectionSet": {
    "PhysicalConnectionType": [
      {
        "Type": "VPC",
        "Status": "Enabled",
        "CreationTime": "2021-08-24T07:30:58Z",
        "AdLocation": "浙江省杭州市XX区XX镇XX路10号",
        "ReservationActiveTime": "2022-02-25T11:01:04Z",
        "ReservationOrderType": "RENEW",
        "PortNumber": "1/1/1",
        "Spec": "10G",
        "ChargeType": "Prepaid",
        "ReservationInternetChargeType": "PayByBandwidth",
        "Description": "desctest",
        "Bandwidth": 10,
        "EnabledTime": "2021-08-24T07:33:18Z",
        "LineOperator": "CT",
        "PeerLocation": "浙江省杭州市XX区XX镇XX路XX号",
        "RedundantPhysicalConnectionId": "pc-119mfjzm****",
        "Name": "nametest",
        "CircuitCode": "longtel001",
        "EndTime": "2022-04-24T16:00:00Z",
        "PortType": "10GBase-LR",
        "BusinessStatus": "Normal",
        "LoaStatus": "Available",
        "AccessPointId": "ap-cn-hangzhou-finance-yh-E",
        "AccessPointType": "VPC",
        "HasReservationData": "false",
        "PhysicalConnectionId": "pc-bp1ciz7ekd2grn1as****",
        "ProductType": "PhysicalConnection",
        "VirtualPhysicalConnectionCount": 0,
        "ParentPhysicalConnectionId": "pc-bp1ciz7ekd2grn1as****",
        "ParentPhysicalConnectionAliUid": 0,
        "VlanId": "10",
        "OrderMode": "PayByPhysicalConnectionOwner",
        "VpconnStatus": "Confirmed",
        "ExpectSpec": "50M",
        "ResourceGroupId": "rg-acfmwu3k52p****",
        "AdDetailLocation": "浙江省杭州市XX区XX镇XX路10号, XX机房, ET135ET135-XX-2包间, JXX机柜,  position30",
        "Tags": {
          "tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "QosId": "qos-bp10s3szn8rgnxuw7****",
        "OpticalModuleModel": "",
        "MacsecKeys": {
          "MacsecKey": [
            {
              "CipherSuite": "",
              "Ckn": "",
              "Cak": "",
              "StartOn": "",
              "Status": ""
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	OperationUnsupported.ResourceGroupId	ResourceGroupId in financial region is unsupported.	The operation is not supported because Alibaba Finance Cloud does not support resource group IDs.
400	InvalidTagKey.Malformed	The specified tag key is invalid.	Invalid tag key value. Specify a valid tag key value and try again.
400	OperationFailed.InternalError	The request processing has failed due to some unknown error.	Unknown error. Please retry the operation. The error still exists. Please submit the work order for processing.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	Filter.X.key is not supported.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.