DescribeCommonBandwidthPackages - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeCommonBandwidthPackages	L'opération à effectuer. Définissez la valeur sur DescribeCommonBandwidthPackages.
IncludeReservationData	Boolean	Non	false	Indique s'il faut renvoyer les informations sur les commandes en attente. Valeurs possibles : false (par défaut) true
RegionId	String	Oui	cn-hangzhou	ID de région de l'instance de bande passante partagée Internet. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
BandwidthPackageId	String	Non	cbwp-2ze2ic1xd2qeqk145****	ID de l'instance de bande passante partagée Internet.
ResourceGroupId	String	Non	rg-acfmxazb4ph****	ID du groupe de ressources.
Name	String	Non	test123	Nom de l'instance de bande passante partagée Internet.
PageNumber	Integer	Non	1	Numéro de page. Valeur par défaut : 1.
PageSize	Integer	Non	10	Nombre d'entrées par page. Valeur maximale : 50. Valeur par défaut : 10.
DryRun	Boolean	Non	false	Indique s'il faut effectuer uniquement un test à blanc, sans exécuter la requête réelle. Valeurs possibles : true : effectue uniquement un test à blanc. Le système vérifie la requête pour détecter d'éventuels problèmes, notamment les paramètres requis, la syntaxe de la requête et l'état de l'instance. Si la requête échoue au test à blanc, un code d'erreur est renvoyé. Si la requête réussit le test à blanc, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : effectue un test à blanc et envoie la requête. Si la requête réussit le test à blanc, un code d'état HTTP 2xx est renvoyé et l'opération est effectuée.
Tag.N.Key	String	Non	KeyTest	Clé du tag N à ajouter à la ressource. Vous pouvez spécifier au maximum 20 clés de tag. La clé de tag ne peut pas être une chaîne vide. La clé de tag peut comporter au maximum 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.
Tag.N.Value	String	Non	ValueTest	Valeur du tag N à ajouter à la ressource. Vous pouvez spécifier au maximum 20 valeurs de tag. La valeur de tag peut être une chaîne vide. La valeur de tag peut comporter jusqu'à 128 caractères et ne peut pas contenir `http://` ou `https://`. La valeur de tag ne peut pas commencer par `aliyun` ou `acs:`.
SecurityProtectionEnabled	Boolean	Non	false	Indique s'il faut activer Anti-DDoS Pro/Premium. Valeurs possibles : false (par défaut) true

Paramètres de réponse

Paramètre	Type	Exemple	Description
PageSize	Integer	10	Nombre d'entrées par page.
RequestId	String	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33	ID de la requête.
PageNumber	Integer	1	Numéro de page.
TotalCount	Integer	1	Nombre total d'entrées.
CommonBandwidthPackages	Array of CommonBandwidthPackage		Détails de l'instance de bande passante partagée Internet.
CommonBandwidthPackage
ReservationActiveTime	String	2018-08-30T16:00:00Z	Date et heure d'effet du renouvellement. Format : `YYYY-MM-DDThh:mm:ssZ`.
Status	String	Available	État de l'instance de bande passante partagée Internet. Valeurs possibles : Available Modifying
CreationTime	String	2017-06-28T06:39:20Z	Date et heure de création de l'instance de bande passante partagée Internet. Format : `YYYY-MM-DDThh:mm:ssZ`.
ReservationOrderType	String	RENEWCHANGE	Méthode de renouvellement. RENEWCHANGE TEMP_UPGRADE UPGRADE
DeletionProtection	Boolean	true	Indique si la protection contre la suppression est activée. true false
ReservationInternetChargeType	String	PayByBandwidth	Nouvelle méthode de facturation. PayByTraffic : facturation au transfert de données.
Ratio	Integer	20	Pourcentage de l'engagement minimal de bande passante. Seule la valeur 20 peut être renvoyée. Remarque Ce paramètre est disponible uniquement sur le site Alibaba Cloud Chine.
InstanceChargeType	String	PostPaid	Méthode de facturation de l'instance de bande passante partagée Internet. Valeurs possibles : PostPaid : paiement à l'utilisation.
RegionId	String	cn-hangzhou	ID de région de l'instance de bande passante partagée Internet.
BandwidthPackageId	String	cbwp-bp1t3sm1ffzmshdki****	ID de l'instance de bande passante partagée Internet.
ServiceManaged	Integer	1	Indique si l'instance de bande passante partagée Internet a été créée par le compte de service. 0 : non 1 : oui
Bandwidth	String	20	Bande passante maximale de l'instance de bande passante partagée Internet. Unité : Mbit/s.
Description	String	none	Description de l'instance de bande passante partagée Internet.
ExpiredTime	String	2019-01-15T03:08:37Z	Date et heure d'expiration de l'instance de bande passante partagée Internet. Format : `YYYY-MM-DDThh:mm:ssZ`.
ReservationBandwidth	String	1000	Nouvelle bande passante maximale. Unité : Mbit/s.
ResourceGroupId	String	rg-acfmxazb4ph****	ID du groupe de ressources.
InternetChargeType	String	PayByBandwidth	Méthode de facturation de l'instance de bande passante partagée Internet. Valeurs possibles : PayByTraffic : facturation au transfert de données.
BusinessStatus	String	Normal	État du service de l'instance de bande passante partagée Internet. Valeurs possibles : Normal FinancialLocked Unactivated
Name	String	abc	Nom de l'instance de bande passante partagée Internet.
ISP	String	BGP	Type de ligne. Valeurs possibles : BGP Les lignes BGP (Multi-ISP) sont disponibles dans toutes les régions. BGP_PRO Les lignes BGP (Multi-ISP) Pro sont disponibles dans les régions Chine (Hong Kong), Singapour, Japon (Tokyo), Philippines (Manille), Malaisie (Kuala Lumpur), Indonésie (Jakarta) et Thaïlande (Bangkok). Si vous êtes autorisé à utiliser la bande passante mono-opérateur, l'une des valeurs suivantes est renvoyée : ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 Si vos services sont déployés dans China East 1 Finance, la valeur BGP_FinanceCloud est renvoyée.
HasReservationData	String	false	Indique si les informations sur les commandes en attente sont renvoyées. Valeurs possibles : false true
PublicIpAddresses	Array of PublicIpAddresse		Adresses IP élastiques (EIP) associées à l'instance de bande passante partagée Internet.
PublicIpAddresse
IpAddress	String	47.95.XX.XX	Adresse IP publique.
AllocationId	String	eip-bp13e9i2qst4g6jzi****	ID de l'EIP.
BandwidthPackageIpRelationStatus	String	BINDED	Indique si l'EIP est associé à l'instance de bande passante partagée Internet. Valeurs possibles : BINDED BINDING
SecurityProtectionTypes	Array of String	AntiDDoS_Enhanced	Édition d'Anti-DDoS. Si ce paramètre est vide, Anti-DDoS Origin Basic est activé. Si AntiDDoS_Enhanced est renvoyé, Anti-DDoS Pro/Premium est activé.
Tags	Array of Tag		Liste des tags.
Tag
Key	String	KeyTest	Clé de tag ajoutée à l'instance de bande passante partagée Internet.
Value	String	ValueTest	Valeur de tag ajoutée à l'instance de bande passante partagée Internet.
BizType	String	CloudBox	Type de service de l'instance de bande passante partagée Internet. CloudBox Seuls les utilisateurs de Cloud Box peuvent sélectionner ce type. Default (par défaut)
Zone	String	ap-southeast-1-lzdvn-cb	Zone de l'instance de bande passante partagée Internet. Ce paramètre est renvoyé uniquement si le type de service est CloudBox. Si le type de service est Default, une valeur vide est renvoyée.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

XML format

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>

JSON format

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"
  } ]
}

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	Description
400	InvalidBandwidthPackageIdNumber.NotSupported	The number of BandwidthPackageIds exceeds the limit.	Le nombre d'instances de bande passante partagée Internet a dépassé le quota.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	L'ID du groupe de ressources est introuvable.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	La fonctionnalité de groupe de ressources est désactivée.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	L'ID de région est introuvable.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.