Mengkueri informasi tentang paket bandwidth.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
cen:DescribeCenBandwidthPackages |
get |
*CenBandwidthPackage
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| IncludeReservationData |
boolean |
No |
Menentukan apakah akan menyertakan data perpanjangan. Nilai yang valid:
|
true |
| PageNumber |
integer |
No |
Nomor halaman yang akan dikembalikan. Nilai default: 1. |
1 |
| PageSize |
integer |
No |
Jumlah entri yang akan dikembalikan di setiap halaman. Nilai maksimum: 50. Nilai default: 10. |
2 |
| IsOrKey |
boolean |
No |
Operator logika antara kondisi filter. Nilai yang valid:
|
false |
| ResourceGroupId |
string |
No |
ID grup sumber daya. |
rg-acfnwjeo4tv**** |
| Filter |
array<object> |
No |
Konfigurasi filter. |
|
|
object |
No |
|||
| Key |
string |
No |
Kondisi filter. Anda dapat menggunakan kondisi filter untuk memfilter paket bandwidth yang ingin Anda kueri. Kondisi filter berikut didukung:
|
CenId |
| Value |
array |
No |
Tentukan nilai filter berdasarkan parameter Key. Anda dapat menentukan beberapa nilai filter untuk setiap Key. Operator logika antara nilai filter adalah OR. Jika satu nilai filter cocok, kondisi filter akan cocok. |
Idle |
|
string |
No |
Tentukan nilai filter berdasarkan parameter Key. Anda dapat menentukan beberapa nilai filter untuk setiap Key. Operator logika antara nilai filter adalah OR. Jika paket bandwidth cocok dengan salah satu nilai filter, paket bandwidth tersebut akan cocok. |
cen-xxjsjfkffkfkfjkf**** |
|
| Tag |
array<object> |
No |
Informasi tentang tag. Anda dapat menentukan paling banyak 20 tag dalam setiap panggilan. |
|
|
object |
No |
|||
| Key |
string |
No |
Kunci tag. Kunci tag tidak boleh berupa string kosong. Kunci tag dapat memiliki panjang hingga 64 karakter dan tidak boleh dimulai dengan Anda dapat menentukan paling banyak 20 kunci tag. |
TagKey |
| Value |
string |
No |
Nilai tag. Nilai tag dapat memiliki panjang 0 hingga 128 karakter, dan tidak boleh dimulai dengan Nilai tag dari setiap kunci tag harus unik. Anda dapat menentukan paling banyak 20 nilai tag dalam setiap panggilan. |
TagValue |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| PageSize |
integer |
Jumlah entri yang dikembalikan per halaman. |
2 |
| RequestId |
string |
ID permintaan. |
9D7E2400-2755-4AF5-9B73-12565E4F73A0 |
| PageNumber |
integer |
Nomor halaman yang dikembalikan. |
1 |
| TotalCount |
integer |
Jumlah total entri yang dikembalikan. |
2 |
| CenBandwidthPackages |
object |
||
| CenBandwidthPackage |
array<object> |
Detail tentang paket bandwidth. |
|
|
array<object> |
|||
| ReservationActiveTime |
string |
The expiration time of the temporary upgrade. |
2021-08-30T16:00Z |
| Status |
string |
Indicates whether the bandwidth plan is associated with a CEN instance.
|
InUse |
| CreationTime |
string |
The time when the bandwidth plan was created. The time is displayed in the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. |
2021-02-01T11:14Z |
| ReservationOrderType |
string |
The renewal method.
|
UPGRADE |
| BandwidthPackageChargeType |
string |
The billing method of the bandwidth plan. |
PREPAY |
| CenBandwidthPackageId |
string |
The ID of the bandwidth plan. |
cenbwp-4c2zaavbvh5x**** |
| ReservationInternetChargeType |
string |
The new billing method. |
PREPAY |
| GeographicRegionAId |
string |
The ID of the area that you want to query. Valid values:
|
china |
| Bandwidth |
integer |
The maximum bandwidth of the bandwidth plan. |
2 |
| Description |
string |
The description of the bandwidth plan. |
cen |
| ExpiredTime |
string |
The time when the bandwidth plan expires. |
2021-09-08T16:00Z |
| ReservationBandwidth |
string |
The bandwidth value to which the bandwidth plan is restored when the temporary upgrade ends. |
10 |
| GeographicSpanId |
string |
The ID of the connected area. |
north-america_china |
| GeographicRegionBId |
string |
The ID of the other area connected by the bandwidth plan. Valid values:
|
north-america |
| ResourceGroupId |
string |
The ID of the resource group to which the ACL belongs. |
rg-aekzoyr5k36**** |
| IsCrossBorder |
boolean |
Indicates whether the bandwidth plan supports cross-border communication.
|
false |
| BusinessStatus |
string |
The status of the bandwidth plan. Valid values:
|
Normal |
| Name |
string |
The name of the bandwidth plan. |
test |
| HasReservationData |
string |
Indicates whether renewal data is included.
Catatan
This parameter returns true only when the IncludeReservationData parameter is set to true and a pending order exists. |
false |
| OrginInterRegionBandwidthLimits |
object |
||
| OrginInterRegionBandwidthLimit |
array<object> |
The details about the connected regions. |
|
|
object |
|||
| BandwidthLimit |
string |
The maximum bandwidth value for the inter-region connection. |
1 |
| OppositeRegionId |
string |
The ID of the peer region. |
us-west-1 |
| GeographicSpanId |
string |
The connected regions. |
north-america_china |
| LocalRegionId |
string |
The ID of the local region. |
cn-hangzhou |
| Tags |
object |
||
| Tag |
array<object> |
The tags of the bandwidth plan. |
|
|
object |
|||
| Key |
string |
The tag key. |
TagKey |
| Value |
string |
The tag value. |
TagValue |
| CenIds |
object |
||
| CenId |
array |
A list of CEN instances that are associated with the bandwidth plan. |
|
|
string |
The ID of the CEN instance that is associated with the bandwidth plan. |
cen-xxjsjfkffkfkfjkf**** |
Contoh
Respons sukses
JSONformat
{
"PageSize": 2,
"RequestId": "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
"PageNumber": 1,
"TotalCount": 2,
"CenBandwidthPackages": {
"CenBandwidthPackage": [
{
"ReservationActiveTime": "2021-08-30T16:00Z",
"Status": "InUse",
"CreationTime": "2021-02-01T11:14Z",
"ReservationOrderType": "UPGRADE",
"BandwidthPackageChargeType": "PREPAY",
"CenBandwidthPackageId": "cenbwp-4c2zaavbvh5x****",
"ReservationInternetChargeType": "PREPAY",
"GeographicRegionAId": "china",
"Bandwidth": 2,
"Description": "cen",
"ExpiredTime": "2021-09-08T16:00Z",
"ReservationBandwidth": "10",
"GeographicSpanId": "north-america_china",
"GeographicRegionBId": "north-america",
"ResourceGroupId": "rg-aekzoyr5k36****",
"IsCrossBorder": false,
"BusinessStatus": "Normal",
"Name": "test",
"HasReservationData": "false",
"OrginInterRegionBandwidthLimits": {
"OrginInterRegionBandwidthLimit": [
{
"BandwidthLimit": "1",
"OppositeRegionId": "us-west-1",
"GeographicSpanId": "north-america_china",
"LocalRegionId": "cn-hangzhou"
}
]
},
"Tags": {
"Tag": [
{
"Key": "TagKey",
"Value": "TagValue"
}
]
},
"CenIds": {
"CenId": [
"cen-xxjsjfkffkfkfjkf****"
]
}
}
]
}
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IllegalParam.TagValue | The tag values are not valid. | The error message returned because the specified tag value is invalid. |
| 400 | IllegalParam.TagKey | The tag keys are not valid. | The error message returned because the specified tag key is invalid. |
| 400 | InvalidParameter | Invalid parameter. | The error message returned because the parameter is set to an invalid value. |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | The error message returned because you do not have the permissions to perform this operation. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.