DescribeVodDomainTrafficData - ApsaraVideo VOD

Anda dapat memanggil operasi ini untuk mengkueri data traffic pada nama domain yang dipercepat. Dibandingkan dengan operasi DescribeVodDomainRealTimeTrafficData, operasi ini mendukung kueri data historis dalam rentang waktu yang lebih panjang—hingga 366 hari terakhir—namun memiliki granularitas waktu minimum 5 menit dan latensi data yang lebih tinggi.

Deskripsi operasi

Titik akhir (endpoint) untuk operasi ini hanya tersedia di wilayah China (Shanghai).
Operasi ini mendukung kueri batch. Anda dapat mengkueri data hingga 500 nama domain dalam satu permintaan.
Jika parameter StartTime dan EndTime tidak ditentukan, data dari 24 jam terakhir akan dikembalikan secara default. Jika kedua parameter tersebut ditentukan, data dalam rentang waktu yang ditetapkan akan dikembalikan.

Granularitas waktu data

Jika parameter Interval tidak diatur, granularitas waktu default dari data yang dikembalikan ditentukan oleh rentang waktu antara StartTime dan EndTime. Tabel berikut menjelaskan granularitas waktu, rentang waktu yang didukung untuk kueri data historis, serta latensi data.

Time granularity	Time span of a single query	Queryable time range for historical data	Data latency
5 minutes	The time span of a single query is less than 3 days	93 days	15 minutes
1 hour	The time span of a single query is greater than or equal to 3 days and less than 31 days	186 days	Usually 3 to 4 hours
1 day	The time span of a single query is greater than or equal to 31 days and less than or equal to 366 days	366 days	Usually 4 hours, but no more than 24 hours

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

vod:DescribeVodDomainTrafficData

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DomainName	string	No	Nama domain yang dipercepat yang ingin Anda kueri. Jika Anda tidak menentukan parameter ini, data gabungan dari semua nama domain yang dipercepat akan dikembalikan secara default. Kueri batch didukung. Pisahkan beberapa nama domain dengan koma (,). Anda dapat mengkueri maksimal 500 nama domain sekaligus. Masuk ke Konsol ApsaraVideo VOD dan pilih Configuration Management > CDN Configuration > Domain Names pada panel navigasi di sebelah kiri untuk melihat nama domain yang dipercepat yang telah ditambahkan ke ApsaraVideo VOD. Anda juga dapat memanggil operasi DescribeVodUserDomains untuk mengkueri daftar nama domain yang dipercepat.	example.com
StartTime	string	No	Awal rentang waktu untuk dikueri. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2019-01-20T13:59:58Z
EndTime	string	No	Akhir rentang waktu untuk dikueri. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC. Catatan Waktu akhir harus lebih lambat daripada waktu mulai.	2019-01-20T14:59:58Z
Interval	string	No	Granularitas waktu data yang akan dikueri. Satuan: detik. Nilai yang valid: 300, 3600, dan 86400. Jika Anda tidak mengatur parameter ini atau mengaturnya ke nilai yang tidak didukung, nilai default akan digunakan. Granularitas waktu yang didukung bervariasi berdasarkan rentang waktu yang ditentukan oleh `StartTime` dan `EndTime`: Jika rentang waktu kurang dari 3 hari, nilai yang valid adalah 300 (default), 3600, dan 86400. Jika rentang waktu antara 3 hingga 31 hari, nilai yang valid adalah 3600 (default) dan 86400. Jika rentang waktu lebih dari 31 hari, nilai yang valid adalah 86400 (default).	300
IspNameEn	string	No	Nama penyedia layanan (carrier). Jika Anda tidak mengatur parameter ini, data dari semua penyedia layanan akan dikueri.	unicom
LocationNameEn	string	No	Nama wilayah. Jika Anda tidak mengatur parameter ini, data dari semua wilayah akan dikueri. Saat ini, hanya wilayah Shanghai yang didukung.	shanghai

Elemen respons

Element	Type	Description	Example
	object	Respons.
EndTime	string	Akhir rentang waktu.	2019-01-20T14:59:58Z
StartTime	string	Awal rentang waktu.	2019-01-20T13:59:58Z
RequestId	string	ID permintaan.	D94E471F-1A27-442E-552D-D4D2000C****
DomainName	string	Nama domain yang dipercepat.	example.com
TotalTraffic	string	Total traffic.	5906662826
DataInterval	string	Interval waktu antara dua entri data berturut-turut. Ini adalah granularitas waktu data. Satuan: detik.	300
TrafficDataPerInterval	object
DataModule	array<object>	Daftar data traffic pada setiap interval waktu.
	object
HttpsDomesticValue	string	Traffic HTTPS pada node L1 di Daratan Tiongkok. Satuan: byte.	0
Value	string	Total traffic. Satuan: byte.	0
OverseasValue	string	Traffic di luar Daratan Tiongkok. Satuan: byte.	0
HttpsValue	string	Total traffic HTTPS pada node L1. Satuan: byte.	0
HttpsOverseasValue	string	Traffic HTTPS pada node L1 di luar Daratan Tiongkok. Satuan: byte.	0
TimeStamp	string	Waktu data. Waktu mengikuti standar ISO 8601 dan ditampilkan dalam UTC.	2019-01-20T13:59:58Z
DomesticValue	string	Traffic di Daratan Tiongkok. Satuan: byte.	0

Contoh

Respons sukses

JSONformat

{
  "EndTime": "2019-01-20T14:59:58Z",
  "StartTime": "2019-01-20T13:59:58Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "DomainName": "example.com",
  "TotalTraffic": "5906662826",
  "DataInterval": "300\n",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "HttpsDomesticValue": "0",
        "Value": "0",
        "OverseasValue": "0",
        "HttpsValue": "0",
        "HttpsOverseasValue": "0",
        "TimeStamp": "2019-01-20T13:59:58Z",
        "DomesticValue": "0"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Both start time and end must be specified
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	End time is earlier than start time
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.