DescribeCommonBandwidthPackages - Internet Shared Bandwidth - Centre de documentation Alibaba Cloud

Consulte la liste des instances de bande passante partagée Internet dans une région.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

vpc:DescribeCommonBandwidthPackages

get

*CommonBandwidthPackage

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
IncludeReservationData	boolean	Non	Indique si les informations sur les commandes en attente doivent être renvoyées. Valeurs valides :	false
RegionId	string	Oui	L'identifiant de la région où réside l'instance de bande passante partagée Internet.	cn-hangzhou
BandwidthPackageId	string	Non	L'identifiant de l'instance de bande passante partagée Internet.	cbwp-2ze2ic1xd2qeqk145****
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmxazb4ph****
Name	string	Non	Le nom de l'instance de bande passante partagée Internet.	test123
PageNumber	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 1 à 50. Valeur par défaut : 10.	10
DryRun	boolean	Non	Indique si un test à blanc doit être effectué, sans exécuter la requête réelle. Valeurs valides :	false
Tag	array<object>	Non	Les balises à ajouter à l'instance de bande passante partagée Internet.
	object	Non
Key	string	Non	La clé de balise à ajouter à l'instance de bande passante partagée Internet. Vous pouvez spécifier jusqu'à 20 clés de balise. La clé de balise ne peut pas être une chaîne vide.	KeyTest
Value	string	Non	La valeur de balise à ajouter à l'instance de bande passante partagée Internet. Vous pouvez spécifier jusqu'à 20 valeurs de balise. La valeur de balise peut être une chaîne vide.	ValueTest
SecurityProtectionEnabled	boolean	Non	Indique si Anti-DDoS Pro/Premium doit être activé. Valeurs valides :	false

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33
PageNumber	integer	Le numéro de page.	1
TotalCount	integer	Le nombre total d'entrées renvoyées.	1
CommonBandwidthPackages	object
CommonBandwidthPackage	array<object>	Les détails de l'instance de bande passante partagée Internet.
	array<object>
ReservationActiveTime	string	The renewal active time, in the format of `YYYY-MM-DDThh:mm:ssZ`.	2018-08-30T16:00:00Z
Status	string	The status of the Internet Shared Bandwidth instance. Valid values: Available: Available. Modifying: Being modified.	Available
CreationTime	string	The time when the Internet Shared Bandwidth instance was created, in the format of `YYYY-MM-DDThh:mm:ssZ`.	2017-06-28T06:39:20Z
ReservationOrderType	string	The renewal with specification change type. Valid values: RENEWCHANGE: Renewal with specification change. TEMP_UPGRADE: Temporary upgrade. UPGRADE: Upgrade.	RENEWCHANGE
DeletionProtection	boolean	Indicates whether deletion protection is enabled. Valid values: true: Enabled. false: Disabled.	true
ReservationInternetChargeType	string	The billing method after the specification change. PayByTraffic: Pay-by-data-transfer.	PayByBandwidth
Ratio	integer	The minimum bandwidth guarantee percentage of the Internet Shared Bandwidth instance. Only 20 is returned. Remarque This parameter is supported only on the China site (aliyun.com).	20
InstanceChargeType	string	The billing method of the Internet Shared Bandwidth instance. PostPaid: Pay-as-you-go.	PostPaid
RegionId	string	The region ID of the Internet Shared Bandwidth instance.	cn-hangzhou
BandwidthPackageId	string	The ID of the Internet Shared Bandwidth instance.	cbwp-bp1t3sm1ffzmshdki****
ServiceManaged	integer	Indicates whether the resource is created by a service account. Valid values: 0: Not created by a service account. 1: Created by a service account.	1
Bandwidth	string	The peak 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 expiration time of the Internet Shared Bandwidth instance, in the format of `YYYY-MM-DDThh:mm:ssZ`.	2019-01-15T03:08:37Z
ReservationBandwidth	string	The bandwidth value after the specification change. Unit: Mbit/s.	1000
ResourceGroupId	string	The resource group ID.	rg-acfmxazb4ph****
InternetChargeType	string	The billing method of the Internet Shared Bandwidth instance. PayByBandwidth: Pay-by-bandwidth. PayByDominantTraffic: Pay-by-dominant-traffic. PayByTraffic: Pay-by-data-transfer.	PayByBandwidth
BusinessStatus	string	The business status of the Internet Shared Bandwidth instance. Valid values: Normal: Normal. FinancialLocked: Overdue payment. Unactivated: 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. All regions support BGP (multi-ISP) lines. BGP_PRO: BGP (multi-ISP) premium line. Currently, only the Hong Kong (China), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions support BGP (multi-ISP) premium Internet Shared Bandwidth instances. If you are a whitelist user of single-ISP bandwidth, the following types may also be returned: ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 If you are a Finance Cloud user in the China (Hangzhou) region, BGP_FinanceCloud is returned.	BGP
HasReservationData	string	Indicates whether there are pending orders. Valid values: false: No pending orders. true: Pending orders exist.	false
PublicIpAddresses	object
PublicIpAddresse	array<object>	The public IP addresses in the Internet Shared Bandwidth instance.
	object	The public IP addresses in the Internet Shared Bandwidth instance.
IpAddress	string	The public IP address.	47.95.XX.XX
AllocationId	string	The instance ID of the public IP address.	eip-bp13e9i2qst4g6jzi****
BandwidthPackageIpRelationStatus	string	The association status between the Internet Shared Bandwidth instance and the EIP. Valid values: BINDED: The EIP is associated with the Internet Shared Bandwidth instance. BINDING: Being associated.	BINDED
SecurityProtectionTypes	object
SecurityProtectionType	array	The security protection level. If the value is empty, default DDoS Basic is used. If AntiDDoS_Enhanced is returned, Anti-DDoS (Enhanced) is used. Remarque This parameter is deprecated.
	string	The security protection level. If the value is empty, default DDoS Basic is used. If AntiDDoS_Enhanced is returned, Anti-DDoS (Enhanced) is used. Remarque This parameter is deprecated.	AntiDDoS_Enhanced
Tags	object
Tag	array<object>	The list of tags associated with the Internet Shared Bandwidth instance.
	object	The list of tags associated with the Internet Shared Bandwidth instance.
Key	string	The tag key of the Internet Shared Bandwidth instance.	KeyTest
Value	string	The tag value of the Internet Shared Bandwidth instance.	ValueTest
BizType	string	The business type of the Internet Shared Bandwidth instance. Valid values: CloudBox: CloudBox. Only CloudBox users support this type. Default (default): Default, indicating a non-special type.	CloudBox
Zone	string	The zone of the Internet Shared Bandwidth instance. When zone resources are overloaded, the Internet Shared Bandwidth instance may be scheduled to another zone to ensure service stability.	ap-southeast-1-lzdvn-cb

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
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.	The operation is not supported. Resource group IDs are not supported in Finance Cloud.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.