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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeCommonBandwidthPackages	A operação a ser executada. Defina o valor como DescribeCommonBandwidthPackages.
IncludeReservationData	Boolean	Não	false	Especifica se as informações sobre pedidos pendentes devem retornar. Valores válidos: false (padrão) true
RegionId	String	Sim	cn-hangzhou	O ID da região da instância de Internet Shared Bandwidth. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
BandwidthPackageId	String	Não	cbwp-2ze2ic1xd2qeqk145****	O ID da instância de Internet Shared Bandwidth.
ResourceGroupId	String	Não	rg-acfmxazb4ph****	O ID do grupo de recursos.
Name	String	Não	test123	O nome da instância de Internet Shared Bandwidth.
PageNumber	Integer	Não	1	O número da página. Valor padrão: 1.
PageSize	Integer	Não	10	O número de entradas por página. Valor máximo: 50. Valor padrão: 10.
DryRun	Boolean	Não	false	Especifica se apenas uma simulação deve ocorrer, sem executar a solicitação real. Valores válidos: true: executa apenas a simulação. O sistema verifica a solicitação em busca de problemas potenciais, incluindo parâmetros obrigatórios, sintaxe da solicitação e status da instância. Se a solicitação falhar na simulação, um código de erro retorna. Caso contrário, o código de erro `DryRunOperation` retorna. false (padrão): executa a simulação e envia a solicitação. Se a solicitação passar na simulação, um código de status HTTP 2xx retorna e a operação é executada.
Tag.N.Key	String	Não	KeyTest	A chave da tag N a adicionar ao recurso. É possível especificar até 20 chaves de tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter no máximo 128 caracteres. Ela não pode começar com `aliyun` ou `acs:`, nem conter `http://` ou `https://`.
Tag.N.Value	String	Não	ValueTest	O valor da tag N a adicionar ao recurso. É possível 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 não pode conter `http://` ou `https://`. Além disso, não pode começar com `aliyun` ou `acs:`.
SecurityProtectionEnabled	Boolean	Não	false	Especifica se o Anti-DDoS Pro/Premium deve ser ativado. Valores válidos: false (padrão) true

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	10	O número de entradas por página.
RequestId	String	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33	O ID da solicitação.
PageNumber	Integer	1	O número da página.
TotalCount	Integer	1	O número de entradas retornadas.
CommonBandwidthPackages	Array of CommonBandwidthPackage		Os detalhes da instância de Internet Shared Bandwidth.
CommonBandwidthPackage
ReservationActiveTime	String	2018-08-30T16:00:00Z	O momento em que a renovação entrou em vigor. O horário segue o formato `YYYY-MM-DDThh:mm:ssZ`.
Status	String	Available	O status da instância de Internet Shared Bandwidth. Valores válidos: Available Modifying
CreationTime	String	2017-06-28T06:39:20Z	O momento de criação da instância de Internet Shared Bandwidth. O horário segue o formato `YYYY-MM-DDThh:mm:ssZ`.
ReservationOrderType	String	RENEWCHANGE	O método de renovação. RENEWCHANGE TEMP_UPGRADE UPGRADE
DeletionProtection	Boolean	true	Indica se a proteção contra exclusão está ativada. true false
ReservationInternetChargeType	String	PayByBandwidth	O novo método de medição. PayByTraffic: pagamento conforme o uso de dados transferidos.
Ratio	Integer	20	A porcentagem do compromisso mínimo de largura de banda. Apenas 20 pode retornar. Nota Este parâmetro está disponível apenas no site da Alibaba Cloud China.
InstanceChargeType	String	PostPaid	O método de faturamento da instância de Internet Shared Bandwidth. Valores válidos: PostPaid: pagamento conforme o uso.
RegionId	String	cn-hangzhou	O ID da região da instância de Internet Shared Bandwidth.
BandwidthPackageId	String	cbwp-bp1t3sm1ffzmshdki****	O ID da instância de Internet Shared Bandwidth.
ServiceManaged	Integer	1	Indica se a conta de serviço criou a instância de Internet Shared Bandwidth. 0: não 1: sim
Bandwidth	String	20	A largura de banda máxima da instância de Internet Shared Bandwidth. Unidade: Mbit/s.
Description	String	none	A descrição da instância de Internet Shared Bandwidth.
ExpiredTime	String	2019-01-15T03:08:37Z	O momento de expiração da instância de Internet Shared Bandwidth. O horário segue o formato `YYYY-MM-DDThh:mm:ssZ`.
ReservationBandwidth	String	1000	A nova largura de banda máxima. Unidade: Mbit/s.
ResourceGroupId	String	rg-acfmxazb4ph****	O ID do grupo de recursos.
InternetChargeType	String	PayByBandwidth	O método de medição da instância de Internet Shared Bandwidth. Valores válidos: PayByTraffic: pagamento conforme o uso de dados transferidos.
BusinessStatus	String	Normal	O status do serviço da instância de Internet Shared Bandwidth. Valores válidos: Normal FinancialLocked Unactivated
Name	String	abc	O nome da instância de Internet Shared Bandwidth.
ISP	String	BGP	O tipo de linha. Valores válidos: BGP: linhas BGP (Multi-ISP) estão disponíveis em todas as regiões. BGP_PRO: linhas BGP (Multi-ISP) Pro estão disponíveis nas regiões China (Hong Kong), Singapura, Japão (Tóquio), Filipinas (Manila), Malásia (Kuala Lumpur), Indonésia (Jacarta) e Tailândia (Bangkok). Se houver permissão para usar largura de banda de ISP único, um dos seguintes valores retorna: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 Se os serviços estiverem implantados na China East 1 Finance, BGP_FinanceCloud retorna.
HasReservationData	String	false	Indica se as informações sobre pedidos pendentes retornaram. Valores válidos: false true
PublicIpAddresses	Array of PublicIpAddresse		Os EIPs associados à instância de Internet Shared Bandwidth.
PublicIpAddresse
IpAddress	String	47.95.XX.XX	O endereço IP público.
AllocationId	String	eip-bp13e9i2qst4g6jzi****	O ID do EIP.
BandwidthPackageIpRelationStatus	String	BINDED	Indica se o EIP está associado à instância de Internet Shared Bandwidth. Valores válidos: BINDED BINDING
SecurityProtectionTypes	Array of String	AntiDDoS_Enhanced	A edição do Anti-DDoS. Se este parâmetro estiver vazio, o Anti-DDoS Origin Basic está ativado. Se AntiDDoS_Enhanced retornar, o Anti-DDoS Pro/Premium está ativado.
Tags	Array of Tag		A lista de tags.
Tag
Key	String	KeyTest	A chave da tag adicionada à instância de Internet Shared Bandwidth.
Value	String	ValueTest	O valor da tag adicionado à instância de Internet Shared Bandwidth.
BizType	String	CloudBox	O tipo de serviço da instância de Internet Shared Bandwidth. CloudBox: apenas usuários de cloud box podem selecionar este tipo. Default (padrão)
Zone	String	ap-southeast-1-lzdvn-cb	A zona da instância de Internet Shared Bandwidth. Este parâmetro retorna apenas se o tipo de serviço for CloudBox. Se o tipo de serviço for Default, um valor vazio retorna.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeCommonBandwidthPackages
&IncludeReservationData=false
&RegionId=cn-hangzhou
&BandwidthPackageId=cbwp-2ze2ic1xd2qeqk145****
&ResourceGroupId=rg-acfmxazb4ph****
&Name=test123
&PageNumber=1
&PageSize=10
&DryRun=false
&Tag=[{"Key":"KeyTest","Value":"ValueTest"}]
&SecurityProtectionEnabled=false
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "CommonBandwidthPackages" : [ {
    "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" : [ {
      "IpAddress" : "47.95.XX.XX",
      "AllocationId" : "eip-bp13e9i2qst4g6jzi****",
      "BandwidthPackageIpRelationStatus" : "BINDED"
    } ],
    "SecurityProtectionTypes" : [ "AntiDDoS_Enhanced" ],
    "Tags" : [ {
      "Key" : "KeyTest",
      "Value" : "ValueTest"
    } ],
    "BizType" : "CloudBox",
    "Zone" : "ap-southeast-1-lzdvn-cb"
  } ]
}

Códigos de erro

HttpCode	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 excedeu a cota.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	O ID do grupo de recursos não foi encontrado.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	O recurso de grupo de recursos está desativado.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	O ID da região não foi encontrado.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.