Referensi API DescribeDomainUsageData - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Deskripsi operasi

This operation supports batch queries for domain names. To query multiple domain names, separate them with commas (,). You can query up to 100 domain names at a time. If you do not specify the DomainName parameter, the operation returns data for all domain names that are associated with your account.
Usage data includes traffic, bandwidth, and the number of requests. The units are bytes, bps, and counts, respectively.
If you do not specify the Interval parameter, you can query data that was generated within the last year. The maximum time range for a single query is 31 days. If the time range is from 1 to 3 days, data is returned with hourly granularity. If the time range is longer than 3 days, data is returned with daily granularity.
If you specify the Interval parameter, the maximum time range for a single query, the queryable historical data range, and the data latency are as follows:

Time granularity	Maximum time range for a single query	Queryable historical data range	Data latency
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours
1 day	90 days	366 days	4:00 AM on the next day

QPS limit

The queries per second (QPS) limit for a single user is 10. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.

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

live:DescribeDomainUsageData

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
DomainName	string	No	Nama domain streaming aliran langsung. Anda dapat mengkueri satu nama domain atau beberapa nama domain. Untuk mengkueri beberapa nama domain, pisahkan dengan koma (,). Jika Anda mengosongkan parameter ini, operasi akan mengembalikan data gabungan untuk semua nama domain streaming aliran langsung Anda.	example.com
StartTime	string	Yes	Awal rentang waktu yang akan dikueri. Tentukan pengatur waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Pengatur waktu harus dalam UTC.	2015-12-10T20:00:00Z
EndTime	string	Yes	Akhir pengatur waktu yang akan dikueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Waktu akhir harus lebih lambat dari waktu mulai. Pengatur waktu tidak boleh melebihi 31 hari.	2015-12-10T21:00:00Z
Type	string	No	Tipe data penggunaan yang akan dikueri. Jika Field diatur ke bps atau traf, nilai valid adalah: rts: Bandwidth atau trafik Real-Time Streaming (RTS). quic: Bandwidth atau trafik QUIC. Jika Field diatur ke req_traf atau req_bps, nilai valid adalah: push (dorong): Bandwidth atau trafik pengambilan aliran. push_proxy (dorong): Bandwidth atau trafik pengambilan aliran yang direlai.	all
Field	string	Yes	Tipe data penggunaan yang akan dikueri. Nilai valid: bps: Bandwidth pemutaran. traf: Trafik. req_traf: Trafik pengambilan aliran jika Type diatur ke push (dorong), atau trafik pengambilan aliran yang direlai jika Type diatur ke push_proxy (dorong). req_bps: Bandwidth pengambilan aliran jika Type diatur ke push (dorong), atau bandwidth pengambilan aliran yang direlai jika Type diatur ke push_proxy (dorong).	traf
Area	string	No	Wilayah. Nilai valid: CN: Tiongkok daratan. OverSeas: wilayah di luar Tiongkok daratan. AP1: Asia Pasifik 1. AP2: Asia Pasifik 2. AP3: Asia Pasifik 3. NA: Amerika Utara. SA: Amerika Selatan. EU: Eropa. MEAA: Timur Tengah dan Afrika. all: semua wilayah. Catatan Jika Anda tidak menentukan parameter ini, nilai default adalah CN. Wilayah didefinisikan sebagai berikut: Asia Pasifik 1 mencakup Hong Kong (Tiongkok), Makau (Tiongkok), Taiwan (Tiongkok), Jepang, dan negara-negara Asia Tenggara kecuali Vietnam dan Indonesia. Asia Pasifik 2 mencakup Indonesia, Korea Selatan, dan Vietnam. Asia Pasifik 3 mencakup Australia dan Selandia Baru. Amerika Utara mencakup Amerika Serikat dan Kanada. Amerika Selatan mencakup Brasil. Eropa mencakup Ukraina, Inggris, Prancis, Belanda, Spanyol, Italia, Swedia, dan Jerman. Timur Tengah dan Afrika mencakup Afrika Selatan, Oman, Uni Emirat Arab, dan Kuwait.	CN
DataProtocol	string	No	Protokol data yang akan dikueri. Nilai valid: http: HTTP. https: HTTPS. quic: QUIC. all (default): semua protokol di atas.	all
Interval	string	No	Granularitas waktu data yang akan dikueri, dalam detik. Ini memaksa operasi untuk mengembalikan data pada granularitas tertentu. Nilai valid: 300 (5 menit), 3600 (1 jam), dan 86400 (1 hari).	300

Catatan

Saat Anda mengkueri data pengatur waktu tertentu T, data stabil pengatur waktu tersebut tersedia dua jam kemudian.
Misalnya, jika Anda mengkueri data untuk pukul 13.00 pada 21 Desember, Anda dapat mengambil data stabil untuk pukul 13.00 dan sebelumnya pada pukul 15.00 tanggal 21 Desember.

Elemen respons

Element	Type	Description	Example
	object
EndTime	string	The end of the time range. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2015-12-10T21:00Z
Type	string	The type of usage data.	all
StartTime	string	The start of the time range. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2015-12-10T20:00Z
RequestId	string	The ID of the request.	B955107D-E658-4E77-B913-E0AC3D31693E
Area	string	The usage region.	CN
DomainName	string	The live streaming domain name.	example.com
DataInterval	string	The time interval between data records, in seconds.	300
UsageDataPerInterval	object
DataModule	array<object>	The usage data for each record.
	object
Value	string	The usage value. If Field is set to traf or req_traf, the unit is bytes. If Field is set to bps or req_bps, the unit is bps. If Field is set to acc, the unit is counts.	423304182
TimeStamp	string	The start time of the time slice. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2015-12-10T20:00:00Z

## Kode error khusus | Kode error | Pesan error | Kode status HTTP | Deskripsi | | --- | --- | --- | --- | | Throttling | Request denied due to throttling. | 503 | Permintaan ditolak karena tingkat permintaan melebihi batas yang diizinkan. | | IllegalOperation | Operation not permitted for this domain. | 403 | Nama domain yang ditentukan tidak valid. | | OperationDenied | ApsaraVideo Live is not activated. | 403 | ApsaraVideo Live tidak diaktifkan untuk akun Anda. | | OperationDenied | Your ApsaraVideo Live service is suspended. | 403 | Layanan ApsaraVideo Live Anda ditangguhkan. | | InvalidDomain.NotFound | The specified domain was not found. | 404 | Nama domain yang ditentukan tidak ada atau bukan milik akun Anda. | | InvalidDomain.Offline | The specified domain is disabled. | 404 | Nama domain yang ditentukan dinonaktifkan. | | ServiceBusy | The domain is being configured. Try again later. | 403 | Nama domain yang ditentukan sedang dikonfigurasi. Anda dapat mencoba lagi nanti. | | InvalidDomain.Configure_failed | Failed to configure the domain. | 500 | Konfigurasi nama domain yang ditentukan gagal. | | InvalidParameter | Invalid parameter. | 400 | Satu atau beberapa parameter tidak valid. | | InvalidParameterProduct | Invalid Product parameter. | 400 | Nilai parameter Product tidak valid. | | InvalidParameterArea | Invalid Area parameter. | 400 | Nilai parameter Area tidak valid. | | InvalidParameterField | Invalid Field parameter. | 400 | Nilai parameter Field tidak valid. | | InvalidParameterStartTime | Invalid StartTime parameter. | 400 | Nilai parameter StartTime tidak valid. | | InvalidParameterEndTime | Invalid EndTime parameter. | 400 | Nilai parameter EndTime tidak valid. | | InvalidTimeRange | The time range cannot exceed 31 days. | 400 | Rentang pengatur waktu yang ditentukan oleh parameter StartTime dan EndTime melebihi 31 hari. | | InvalidParameterInterval | Invalid Interval parameter. | 400 | Nilai parameter Interval tidak valid. |.

Contoh

Respons sukses

JSONformat

{
  "EndTime": "2015-12-10T21:00Z",
  "Type": "all",
  "StartTime": "2015-12-10T20:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T20:00:00Z"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvaildParameter	Invalid Parameter
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidTime.Malformed	Specified Time is malformed.
400	InvalidParameterField	The specified Field is invalid.
400	InvalidParameterType	The specified Type is invalid.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.
400	InvalidTimeSpan	The time span exceeds the limit.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.