DescribeCommonBandwidthPackages - Internet Shared Bandwidth: Central de Documentação do Alibaba Cloud

Consulta uma lista de instâncias de Internet Shared Bandwidth e seus detalhes em uma região especificada.

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:DescribeCommonBandwidthPackages

get

*CommonBandwidthPackage

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
IncludeReservationData	boolean	Não	Especifica se deve incluir dados de assinatura que ainda não entraram em vigor. Valores válidos: false (padrão): Não inclui dados de assinatura que ainda não entraram em vigor. true: Inclui dados de assinatura que ainda não entraram em vigor.	false
RegionId	string	Sim	O ID da região da instância de Internet Shared Bandwidth. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
BandwidthPackageId	string	Não	O ID da instância de Internet Shared Bandwidth.	cbwp-2ze2ic1xd2qeqk145****
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxazb4ph****
Name	string	Não	O nome da instância de Internet Shared Bandwidth. O nome deve ter de 0 a 128 caracteres e não pode começar com `http://` ou `https://`.	test123
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor máximo: 50. Valor padrão: 10.	10
DryRun	boolean	Não	Especifica se deve apenas pré-verificar a solicitação. Valores válidos: true: pré-verifica a solicitação sem consultar as informações da instância. O sistema verifica se os parâmetros obrigatórios foram especificados, o formato da solicitação e o status da instância. Se a solicitação falhar na pré-verificação, o erro correspondente será retornado. Se a solicitação passar na pré-verificação, o código de erro `DryRunOperation` será retornado. false (padrão): envia a solicitação. Se a solicitação passar na pré-verificação, o código de status HTTP 2xx será retornado e a operação será executada.	false
Tag	array<object>	Não	As tags da instância de Internet Shared Bandwidth.
	object	Não	As tags da instância de Internet Shared Bandwidth.
Key	string	Não	A chave da tag do recurso. Você pode especificar até 20 chaves de tag. Se você especificar este parâmetro, não poderá especificar uma string vazia. Uma chave de tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	KeyTest
Value	string	Não	O valor da tag do recurso. Você pode especificar até 20 valores de tag. Se você especificar este parâmetro, poderá especificar uma string vazia. Um valor de tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	ValueTest
SecurityProtectionEnabled	boolean	Não	Especifica se deve ativar o Anti-DDoS (Enhanced). Valores válidos: false: não ativa o Anti-DDoS (Enhanced). true: ativa o Anti-DDoS (Enhanced). [Descontinuado]	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas.	1
CommonBandwidthPackages	object
CommonBandwidthPackage	array<object>	Os detalhes das instâncias de Internet Shared Bandwidth.
	array<object>	Os detalhes das instâncias de Internet Shared Bandwidth.
ReservationActiveTime	string	O período de vigência da renovação. O horário segue o formato `YYYY-MM-DDThh:mm:ssZ`.	2018-08-30T16:00:00Z
Status	string	O status da instância de Internet Shared Bandwidth. Valores válidos: Available: A instância está disponível. Modifying: A instância está sendo modificada.	Available
CreationTime	string	A hora em que a instância de Internet Shared Bandwidth foi criada. O horário segue o formato `YYYY-MM-DDThh:mm:ssZ`.	2017-06-28T06:39:20Z
ReservationOrderType	string	O método de renovação e alteração de especificação. Valores válidos: RENEWCHANGE: renovação com alteração de especificação. TEMP_UPGRADE: upgrade temporário. UPGRADE: upgrade.	RENEWCHANGE
DeletionProtection	boolean	Indica se a proteção contra exclusão está ativada. Valores válidos: true: A proteção contra exclusão está ativada. false: A proteção contra exclusão está desativada.	true
ReservationInternetChargeType	string	O método de cobrança após a alteração da especificação. PayByTraffic: Cobrança por transferência de dados.	PayByBandwidth
Ratio	integer	A porcentagem garantida da instância de Internet Shared Bandwidth. Apenas 20 é retornado. Este parâmetro é suportado apenas no site da China.	20
InstanceChargeType	string	O método de cobrança da instância de Internet Shared Bandwidth. PostPaid: Pós-pago.	PostPaid
RegionId	string	O ID da região da instância de Internet Shared Bandwidth.	cn-hangzhou
BandwidthPackageId	string	O ID da instância de Internet Shared Bandwidth.	cbwp-bp1t3sm1ffzmshdki****
ServiceManaged	integer	Indica se o recurso foi criado por uma conta de serviço. Valores válidos: 0: O recurso não foi criado por uma conta de serviço. 1: O recurso foi criado por uma conta de serviço.	1
Bandwidth	string	A largura de banda de pico da instância de Internet Shared Bandwidth. Unidade: Mbit/s.	20
Description	string	A descrição da instância de Internet Shared Bandwidth.	none
ExpiredTime	string	O horário de expiração da instância de Internet Shared Bandwidth. O horário segue o formato `YYYY-MM-DDThh:mm:ssZ`.	2019-01-15T03:08:37Z
ReservationBandwidth	string	O valor de largura de banda após a alteração da especificação. Unidade: Mbit/s.	1000
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxazb4ph****
InternetChargeType	string	O método de cobrança da instância de Internet Shared Bandwidth. PayByBandwidth: Cobrança por largura de banda. PayByDominantTraffic: Cobrança por transferência de dados dominante. PayByTraffic: Cobrança por transferência de dados.	PayByBandwidth
BusinessStatus	string	O status de negócios da instância de Internet Shared Bandwidth. Valores válidos: Normal: A instância está em um estado normal. FinancialLocked: A instância está bloqueada devido a um pagamento em atraso. Unactivated: A instância não está ativada.	Normal
Name	string	O nome da instância de Internet Shared Bandwidth.	abc
ISP	string	O tipo de linha. Valores válidos: BGP: Linha BGP (multi-ISP). As linhas BGP (multi-ISP) são suportadas em todas as regiões. BGP_PRO: Linha BGP (multi-ISP) Pro. As linhas BGP (multi-ISP) Pro são suportadas apenas nas regiões de Hong Kong (China), Cingapura, Japão (Tóquio), Filipinas (Manila), Malásia (Kuala Lumpur), Indonésia (Jacarta) e Tailândia (Bangkok) para Internet Shared Bandwidth. Se você for um usuário incluído na lista de permissões de largura de banda de ISP único, os seguintes valores também poderão ser retornados: ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 Se você for um usuário do Alibaba Finance Cloud na região de Hangzhou, BGP_FinanceCloud será retornado.	BGP
HasReservationData	string	Indica se há pedidos pendentes. Valores válidos: false: Não há pedidos pendentes. true: Há pedidos pendentes.	false
PublicIpAddresses	object
PublicIpAddresse	array<object>	Os endereços IP públicos na instância de Internet Shared Bandwidth.
	object	Os endereços IP públicos na instância de Internet Shared Bandwidth.
IpAddress	string	O endereço IP público.	47.95.XX.XX
AllocationId	string	O ID da instância do endereço IP público.	eip-bp13e9i2qst4g6jzi****
BandwidthPackageIpRelationStatus	string	O status de associação entre a instância de Internet Shared Bandwidth e o EIP. Valores válidos: BINDED: O EIP está associado à instância de Internet Shared Bandwidth. BINDING: O EIP está sendo associado à instância de Internet Shared Bandwidth.	BINDED
SecurityProtectionTypes	object
SecurityProtectionType	array	O nível de proteção de segurança. Valores válidos: Se este parâmetro estiver vazio, o Anti-DDoS Basic padrão será usado. AntiDDoS_Enhanced: O Anti-DDoS (Enhanced) é usado. [Descontinuado]
	string	O nível de proteção de segurança. Valores válidos: Se este parâmetro estiver vazio, o Anti-DDoS Basic padrão será usado. AntiDDoS_Enhanced: O Anti-DDoS (Enhanced) é usado. [Descontinuado]	AntiDDoS_Enhanced
Tags	object
Tag	array<object>	As tags da instância de Internet Shared Bandwidth.
	object	As tags da instância de Internet Shared Bandwidth.
Key	string	A chave da tag da instância de Internet Shared Bandwidth.	KeyTest
Value	string	O valor da tag da instância de Internet Shared Bandwidth.	ValueTest
BizType	string	O tipo de negócio da instância de Internet Shared Bandwidth. Valores válidos: CloudBox: CloudBox. Este tipo é suportado apenas para usuários do CloudBox. Default (padrão): O tipo padrão, que indica nenhum tipo especial.	CloudBox
Zone	string	A zona da instância de Internet Shared Bandwidth. Quando os recursos na zona estão sobrecarregados, a instância de Internet Shared Bandwidth pode ser agendada para outra zona para garantir a estabilidade do serviço.	ap-southeast-1-lzdvn-cb

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33",
  "PageNumber": 1,
  "TotalCount": 1,
  "CommonBandwidthPackages": {
    "CommonBandwidthPackage": [
      {
        "ReservationActiveTime": "2018-08-30T16:00:00Z",
        "Status": "Available",
        "CreationTime": "2017-06-28T06:39:20Z",
        "ReservationOrderType": "RENEWCHANGE",
        "DeletionProtection": true,
        "ReservationInternetChargeType": "PayByBandwidth",
        "Ratio": 20,
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-hangzhou",
        "BandwidthPackageId": "cbwp-bp1t3sm1ffzmshdki****",
        "ServiceManaged": 1,
        "Bandwidth": "20",
        "Description": "none",
        "ExpiredTime": "2019-01-15T03:08:37Z",
        "ReservationBandwidth": "1000",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "InternetChargeType": "PayByBandwidth",
        "BusinessStatus": "Normal",
        "Name": "abc",
        "ISP": "BGP",
        "HasReservationData": "false",
        "PublicIpAddresses": {
          "PublicIpAddresse": [
            {
              "IpAddress": "47.95.XX.XX",
              "AllocationId": "eip-bp13e9i2qst4g6jzi****",
              "BandwidthPackageIpRelationStatus": "BINDED"
            }
          ]
        },
        "SecurityProtectionTypes": {
          "SecurityProtectionType": [
            "AntiDDoS_Enhanced"
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "KeyTest",
              "Value": "ValueTest"
            }
          ]
        },
        "BizType": "CloudBox",
        "Zone": "ap-southeast-1-lzdvn-cb"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidBandwidthPackageIdNumber.NotSupported	The number of BandwidthPackageIds exceeds the limit.	O número de instâncias de Internet Shared Bandwidth excede o limite de cota.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	O ID do grupo de recursos não existe.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	A funcionalidade de grupo de recursos não está ativada.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.