DescribeCommonBandwidthPackages - Internet Shared Bandwidth

Mengkueri paket bandwidth EIP dan informasi tentang paket bandwidth EIP di region tertentu dengan memanggil operasi DescribeCommonBandwidthPackages.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
IncludeReservationData	boolean	No	Menentukan apakah akan menyertakan pesanan yang belum berlaku. Nilai yang valid: false (default): tidak menyertakan. true: menyertakan.	false
RegionId	string	Yes	ID region dari paket bandwidth EIP. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar region terbaru.	cn-hangzhou
BandwidthPackageId	string	No	ID paket bandwidth EIP.	cbwp-2ze2ic1xd2qeqk145****
ResourceGroupId	string	No	ID grup sumber daya.	rg-acfmxazb4ph****
Name	string	No	Nama paket bandwidth EIP. Nama harus terdiri dari 0 hingga 128 karakter dan tidak boleh dimulai dengan `http://` atau `https://`.	test123
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai maksimum: 50. Nilai default: 10.	10
DryRun	boolean	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: melakukan dry run. Sistem memeriksa parameter yang diperlukan, sintaks permintaan, dan status instans. Jika permintaan gagal pemeriksaan, pesan kesalahan terkait akan dikembalikan. Jika permintaan lolos pemeriksaan, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): melakukan dry run dan mengirim permintaan. Setelah permintaan lolos pemeriksaan, kode status HTTP 2xx dikembalikan dan operasi dijalankan.	false
Tag	array<object>	No	Tag dari paket bandwidth EIP.
	object	No	Tag dari paket bandwidth EIP.
Key	string	No	Kunci tag. Anda dapat menentukan paling banyak 20 kunci tag. Kunci tag tidak boleh berupa string kosong. Kunci tag dapat memiliki panjang hingga 128 karakter, dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Kunci tag tidak boleh berisi `http://` atau `https://`.	KeyTest
Value	string	No	Nilai tag. Anda dapat menentukan paling banyak 20 nilai tag. Nilai tag boleh berupa string kosong. Nilai tag dapat memiliki panjang hingga 128 karakter, dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Nilai tag tidak boleh berisi `http://` atau `https://`.	ValueTest
SecurityProtectionEnabled	boolean	No	Menentukan apakah akan mengaktifkan Anti-DDoS Pro/Premium. Nilai yang valid: false: tidak. true: ya. Catatan Parameter ini tidak lagi didukung.	false

Elemen respons

Element	Type	Description	Example
	object	Daftar parameter yang dikembalikan.
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
RequestId	string	ID permintaan.	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33
PageNumber	integer	Nomor halaman.	1
TotalCount	integer	Jumlah total entri yang dikembalikan.	1
CommonBandwidthPackages	object
CommonBandwidthPackage	array<object>	Informasi tentang paket bandwidth EIP.
	array<object>	Informasi tentang paket bandwidth EIP.
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. Catatan 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

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidBandwidthPackageIdNumber.NotSupported	The number of BandwidthPackageIds exceeds the limit.
400	InvalidResourceGroupId	The specified ResourceGroupId 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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.