DescribeDomainUsageData - ApsaraVideo Live

Deskripsi operasi

Operasi ini mendukung kueri batch untuk nama domain. Untuk mengkueri beberapa nama domain, pisahkan dengan koma (,). Anda dapat mengkueri hingga 100 nama domain sekaligus. Jika parameter DomainName tidak ditentukan, operasi ini akan mengembalikan data untuk semua nama domain yang terkait dengan akun Anda.
Data penggunaan mencakup traffic, bandwidth, dan jumlah permintaan, dengan satuan masing-masing byte, bps, dan counts.
Jika parameter Interval tidak ditentukan, Anda dapat mengkueri data yang dihasilkan dalam satu tahun terakhir. Rentang waktu maksimum untuk satu kueri adalah 31 hari. Untuk rentang waktu 1 hingga 3 hari, data dikembalikan dengan granularitas per jam; untuk rentang waktu lebih dari 3 hari, data dikembalikan dengan granularitas harian.
Jika parameter Interval ditentukan, berikut adalah batasan terkait rentang waktu maksimum untuk satu kueri, rentang data historis yang dapat dikueri, serta latensi data:

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

Batas QPS

Batas queries per second (QPS) untuk satu pengguna adalah 10. Jika batas ini dilampaui, panggilan API akan dikenai throttling, yang dapat memengaruhi bisnis Anda. Rencanakan panggilan API secara sesuai.

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 live. 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 live Anda.	example.com
StartTime	string	Yes	Awal rentang waktu untuk dikueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC.	2015-12-10T20:00:00Z
EndTime	string	Yes	Akhir rentang waktu untuk dikueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Waktu akhir harus lebih lambat dari waktu mulai. Rentang waktu tidak boleh melebihi 31 hari.	2015-12-10T21:00:00Z
Type	string	No	Jenis data penggunaan yang akan dikueri. Jika Field diatur ke bps atau traf, nilai yang valid adalah: rts: Bandwidth atau traffic Streaming Real-Time (RTS). quic: Bandwidth atau traffic QUIC. Jika Field diatur ke req_traf atau req_bps, nilai yang valid adalah: push: Bandwidth atau traffic stream ingest. push_proxy: Bandwidth atau traffic stream ingest yang direlay.	all
Field	string	Yes	Jenis data penggunaan yang akan dikueri. Nilai yang valid: bps: Bandwidth pemutaran. traf: Traffic. req_traf: Traffic stream ingest jika Type diatur ke push, atau traffic stream ingest yang direlay jika Type diatur ke push_proxy. req_bps: Bandwidth stream ingest jika Type diatur ke push, atau bandwidth stream ingest yang direlay jika Type diatur ke push_proxy.	traf
Area	string	No	Wilayah. Nilai yang valid: CN: Tiongkok daratan. OverSeas: Wilayah 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-nya adalah CN. Wilayah-wilayah tersebut didefinisikan sebagai berikut:Asia Pasifik 1: Hong Kong (Tiongkok), Makau (Tiongkok), Taiwan (Tiongkok), Jepang, dan negara-negara Asia Tenggara kecuali Vietnam dan Indonesia.Asia Pasifik 2: Indonesia, Korea Selatan, dan Vietnam.Asia Pasifik 3: Australia dan Selandia Baru.Amerika Utara: Amerika Serikat dan Kanada.Amerika Selatan: Brasil.Eropa: Ukraina, Inggris, Prancis, Belanda, Spanyol, Italia, Swedia, dan Jerman.Timur Tengah dan Afrika: Afrika Selatan, Oman, Uni Emirat Arab, dan Kuwait.	CN
DataProtocol	string	No	Protokol data yang akan dikueri. Nilai yang 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. Parameter ini memaksa operasi mengembalikan data dengan granularitas tertentu. Nilai yang valid: 300 (5 menit), 3600 (1 jam), dan 86400 (1 hari).	300

Catatan

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

Elemen respons

Element	Type	Description	Example
	object
EndTime	string	Akhir rentang waktu. Waktu dalam UTC dengan format yyyy-MM-ddTHH:mm:ssZ.	2015-12-10T21:00Z
Type	string	Jenis data penggunaan.	all
StartTime	string	Mulai rentang waktu. Waktu dalam UTC dengan format yyyy-MM-ddTHH:mm:ssZ.	2015-12-10T20:00Z
RequestId	string	ID permintaan.	B955107D-E658-4E77-B913-E0AC3D31693E
Area	string	Wilayah penggunaan.	CN
DomainName	string	Nama domain streaming live.	example.com
DataInterval	string	Interval waktu antar catatan data, dalam detik.	300
UsageDataPerInterval	object
DataModule	array<object>	Data penggunaan untuk setiap catatan.
	object
Value	string	Nilai penggunaan. Jika Field diatur ke traf atau req_traf, satuannya adalah byte. Jika Field diatur ke bps atau req_bps, satuannya adalah bps. Jika Field diatur ke acc, satuannya adalah jumlah (counts).	423304182
TimeStamp	string	Waktu mulai irisan waktu. Waktu dalam UTC dengan format yyyy-MM-ddTHH:mm:ssZ.	2015-12-10T20:00:00Z

## Kode kesalahan khusus | Kode kesalahan | Pesan kesalahan | Kode status HTTP | Deskripsi | | --- | --- | --- | --- | | Throttling | Permintaan ditolak karena throttling. | 503 | Permintaan ditolak karena laju permintaan melebihi batas yang diizinkan. | | IllegalOperation | Operasi tidak diizinkan untuk domain ini. | 403 | Nama domain yang ditentukan tidak valid. | | OperationDenied | ApsaraVideo Live belum diaktifkan. | 403 | ApsaraVideo Live belum diaktifkan untuk akun Anda. | | OperationDenied | Layanan ApsaraVideo Live Anda ditangguhkan. | 403 | Layanan ApsaraVideo Live Anda ditangguhkan. | | InvalidDomain.NotFound | Domain yang ditentukan tidak ditemukan. | 404 | Nama domain yang ditentukan tidak ada atau tidak termasuk dalam akun Anda. | | InvalidDomain.Offline | Domain yang ditentukan dinonaktifkan. | 404 | Nama domain yang ditentukan dinonaktifkan. | | ServiceBusy | Domain sedang dikonfigurasi. Coba lagi nanti. | 403 | Nama domain yang ditentukan sedang dikonfigurasi. Anda dapat mencoba lagi nanti. | | InvalidDomain.Configure_failed | Gagal mengonfigurasi domain. | 500 | Konfigurasi nama domain yang ditentukan gagal. | | InvalidParameter | Parameter tidak valid. | 400 | Satu atau beberapa parameter tidak valid. | | InvalidParameterProduct | Parameter Product tidak valid. | 400 | Nilai parameter Product tidak valid. | | InvalidParameterArea | Parameter Area tidak valid. | 400 | Nilai parameter Area tidak valid. | | InvalidParameterField | Parameter Field tidak valid. | 400 | Nilai parameter Field tidak valid. | | InvalidParameterStartTime | Parameter StartTime tidak valid. | 400 | Nilai parameter StartTime tidak valid. | | InvalidParameterEndTime | Parameter EndTime tidak valid. | 400 | Nilai parameter EndTime tidak valid. | | InvalidTimeRange | Rentang waktu tidak boleh melebihi 31 hari. | 400 | Rentang waktu yang ditentukan oleh parameter StartTime dan EndTime melebihi 31 hari. | | InvalidParameterInterval | Parameter Interval tidak valid. | 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.