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

Consulta uma lista de instâncias de Internet Shared Bandwidth em uma região.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
IncludeReservationData	boolean	Não	Especifica se as informações sobre pedidos pendentes devem ser retornadas. Valores válidos: false (padrão) true	false
RegionId	string	Sim	O ID da região onde a instância de Internet Shared Bandwidth reside. 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.	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. Valores válidos: 1 a 50. Valor padrão: 10.	10
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run, sem executar a solicitação real. Valores válidos: true: realiza apenas um dry run. O sistema verifica a solicitação em busca de possíveis problemas, incluindo valores de parâmetros ausentes, sintaxe de solicitação incorreta e status da instância. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro `DryRunOperation` será retornado. false (padrão): realiza um dry run e executa a solicitação real. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado e a operação será executada.	false
Tag	array<object>	Não	As tags a serem adicionadas à instância de Internet Shared Bandwidth.
	object	Não
Key	string	Não	A chave da tag a ser adicionada à instância de Internet Shared Bandwidth. 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é 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 a ser adicionado à instância de Internet Shared Bandwidth. 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. Não pode começar com `aliyun` ou `acs:`, e não pode conter `http://` ou `https://`.	ValueTest
SecurityProtectionEnabled	boolean	Não	Especifica se o Anti-DDoS Pro/Premium deve ser ativado. Valores válidos: false (padrão) true	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 retornadas.	1
CommonBandwidthPackages	object
CommonBandwidthPackage	array<object>	Os detalhes da instância de Internet Shared Bandwidth.
	array<object>
ReservationActiveTime	string	The time when the renewal took effect. The time is displayed in the `YYYY-MM-DDThh:mm:ssZ` format.	2018-08-30T16:00:00Z
Status	string	The status of the Internet Shared Bandwidth instance. Valid values: Available: The Internet Shared Bandwidth instance is available. Modifying: The Internet Shared Bandwidth instance is being modified.	Available
CreationTime	string	The time when the Internet Shared Bandwidth instance was created. The time is displayed in the `YYYY-MM-DDThh:mm:ssZ` format.	2017-06-28T06:39:20Z
ReservationOrderType	string	The renewal method. Valid values: RENEWCHANGE: renewal with a specification change TEMP_UPGRADE: renewal with a temporary upgrade UPGRADE: renewal with an upgrade	RENEWCHANGE
DeletionProtection	boolean	Indicates whether deletion protection is enabled. Valid values: true false	true
ReservationInternetChargeType	string	The metering method after the configurations are changed. Valid value: PayByTraffic	PayByBandwidth
Ratio	integer	The percentage of the minimum bandwidth commitment. Only 20 is returned. Nota This parameter is supported only on the Alibaba Cloud China site.	20
InstanceChargeType	string	The billing method of the Internet Shared Bandwidth instance. Valid value: PostPaid: pay-as-you-go	PostPaid
RegionId	string	The ID of the region where the Internet Shared Bandwidth instance resides.	cn-hangzhou
BandwidthPackageId	string	The ID of the Internet Shared Bandwidth instance.	cbwp-bp1t3sm1ffzmshdki****
ServiceManaged	integer	Indicates whether the resource is created by the service account. Valid values: 0: The resource is not created by the service account. 1: The resource is created by the service account.	1
Bandwidth	string	The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.	20
Description	string	The description of the Internet Shared Bandwidth instance.	none
ExpiredTime	string	The time when the Internet Shared Bandwidth instance expired. The time is displayed in the `YYYY-MM-DDThh:mm:ssZ` format.	2019-01-15T03:08:37Z
ReservationBandwidth	string	The new maximum bandwidth after the configurations are changed. Unit: Mbit/s.	1000
ResourceGroupId	string	The ID of the resource group.	rg-acfmxazb4ph****
InternetChargeType	string	The metering method of the Internet Shared Bandwidth instance. Valid value: PayByTraffic	PayByBandwidth
BusinessStatus	string	The service status of the Internet Shared Bandwidth instance. Valid values: Normal: The Internet Shared Bandwidth instance runs as expected. FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance Unactivated: The Internet Shared Bandwidth instance is not activated.	Normal
Name	string	The name of the Internet Shared Bandwidth instance.	abc
ISP	string	The line type. Valid values: BGP: BGP (Multi-ISP) line The BGP (Multi-ISP) line is supported in all regions. BGP_PRO: BGP (Multi-ISP) Pro line The BGP (Multi-ISP) Pro line is supported in the China (Hong Kong), Singapore (Singapore), Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions. If you are allowed to use single-ISP bandwidth, one of the following values is returned: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 If your services are deployed in China East 1 Finance, BGP_FinanceCloud is returned.	BGP
HasReservationData	string	Indicates whether the information about pending orders is returned. Valid values: false true	false
PublicIpAddresses	object
PublicIpAddresse	array<object>	The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.
	object
IpAddress	string	The public IP address.	47.95.XX.XX
AllocationId	string	The ID of the EIP.	eip-bp13e9i2qst4g6jzi****
BandwidthPackageIpRelationStatus	string	Indicates whether the EIP is associated with the Internet Shared Bandwidth instance. Valid values: BINDED BINDING	BINDED
SecurityProtectionTypes	object
SecurityProtectionType	array	The editions of Anti-DDoS. If this parameter is empty, Anti-DDoS Origin Basic is enabled. If AntiDDoS_Enhanced is returned, Anti-DDoS Pro/Premium is enabled.
	string	The edition of Anti-DDoS. If this parameter is empty, Anti-DDoS Origin Basic is enabled. If AntiDDoS_Enhanced is returned, Anti-DDoS Pro/Premium is enabled.	AntiDDoS_Enhanced
Tags	object
Tag	array<object>	The tag that is added to the Internet Shared Bandwidth instance.
	object
Key	string	The tag key that is added to the Internet Shared Bandwidth instance.	KeyTest
Value	string	The tag value that is added to the Internet Shared Bandwidth instance.	ValueTest
BizType	string	The service type of the Internet Shared Bandwidth instance. Valid values: CloudBox The cloud box. Only cloud box users can select this type. Default (default): The general service type.	CloudBox
Zone	string	The zone of the Internet Shared Bandwidth instance. This parameter is returned only when BizType is set to CloudBox. If BizType is set to Default, an empty value is returned.	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.	The number of BandwidthPackageIds exceeds the limit.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	The specified resource group ID does not exist.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.
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.