ListSites - Edge Security Acceleration - Alibaba Cloud Documentation Center

Mengkueri daftar situs di bawah pengguna saat ini, termasuk nama situs, status, dan konfigurasi.

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

esa:ListSites

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SiteName	string	No	Nama situs. Digunakan sebagai kondisi filter untuk kueri.
SiteSearchType	string	No	Mode pencocokan pencarian untuk nama situs. Default adalah pencocokan tepat. Nilai valid: prefix: pencocokan awalan. suffix: pencocokan akhiran. exact: pencocokan tepat. fuzzy: Pencocokan kabur.
PageNumber	integer	No	Nomor halaman untuk paging. Nilai harus lebih besar dari atau sama dengan 1.
PageSize	integer	No	Jumlah entri per halaman untuk paging. Nilai valid: 1 hingga 500.
TagFilter	array<object>	No	Aturan filter tag.
	object	No
Key	string	No	Kunci tag. Digunakan sebagai kondisi filter untuk kueri.
Value	string	No	Nilai tag. Digunakan sebagai kondisi filter untuk kueri.
ResourceGroupId	string	No	ID kelompok sumber daya. Digunakan sebagai kondisi filter untuk kueri.
Status	string	No	Status situs. Digunakan sebagai kondisi filter untuk kueri.
OnlyEnterprise	boolean	No	Apakah akan mengkueri hanya situs Edisi Perusahaan. Atur parameter ini ke true untuk mengkueri hanya situs Edisi Perusahaan.
PlanSubscribeType	string	No	Tipe langganan paket. Nilai valid: basicplan: Edisi Dasar. standardplan: Edisi Standar. advancedplan: Edisi Premium. enterpriseplan: Edisi Perusahaan.
Coverage	string	No	Wilayah akselerasi. Nilai valid: domestic: hanya daratan Tiongkok. global: global. overseas: global (tidak termasuk daratan Tiongkok).
AccessType	string	No	Tipe akses. Nilai valid: NS: akses berbasis NS. CNAME: akses berbasis Nama Domain CNAME.
OrderBy	string	No	Bidang pengurutan. Secara default, hasil diurutkan berdasarkan waktu pembuatan. Nilai valid: gmtCreate: waktu pembuatan situs. visitTime: waktu akses situs.

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.
PageNumber	integer	Nomor halaman data yang dikembalikan.
PageSize	integer	Jumlah situs yang ditampilkan per halaman.
TotalCount	integer	Jumlah total situs.
Sites	array<object>	Daftar informasi situs yang dikueri.
	array<object>
AccessType	string	Tipe akses situs. Nilai valid: NS: akses berbasis NS. CNAME: akses berbasis Nama Domain CNAME.
CnameZone	string	Akhiran Nama Domain CNAME situs. Untuk situs yang menggunakan akses berbasis Nama Domain CNAME, ini adalah akhiran Nama Domain CNAME yang perlu dikonfigurasi untuk rekaman.
Coverage	string	Wilayah akselerasi situs. Nilai valid: domestic: hanya daratan Tiongkok. global: global. overseas: global (tidak termasuk daratan Tiongkok).
CreateTime	string	Waktu pembuatan situs. Waktu dalam format ISO 8601 dan ditampilkan dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
UpdateTime	string	Waktu pembaruan situs. Waktu dalam format ISO 8601 dan ditampilkan dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
InstanceId	string	ID instans paket yang dilampirkan ke situs.
NameServerList	string	Daftar name server yang ditetapkan ke situs. Beberapa nilai dipisahkan oleh koma (,).
PlanName	string	Nama paket.
PlanSpecName	string	Nama spesifikasi paket situs.
ResourceGroupId	string	ID kelompok sumber daya.
SiteId	integer	ID situs.
SiteName	string	Nama situs.
Status	string	Status situs. Nilai valid: pending: situs sedang menunggu konfigurasi. active: situs diaktifkan. offline: situs offline. moved: situs telah digantikan.
Tags	object	Tag situs.
VerifyCode	string	Kode verifikasi kepemilikan situs. Ketika situs menggunakan akses berbasis Nama Domain CNAME, kode verifikasi TXT ini harus dikonfigurasi.
VisitTime	string	Waktu akses situs. Waktu dalam format ISO 8601 dan ditampilkan dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
OfflineReason	string	Alasan situs dinonaktifkan. Nilai valid: expiration_ arrears: Paket langganan telah kedaluwarsa atau akun memiliki Pembayaran tertunda. internally_disabled: Situs dinonaktifkan oleh sistem. missing_icp: Nama domain tidak memiliki Pendaftaran ICP. content_violation: Pelanggaran konten. proactively_disabled: Anda secara proaktif menonaktifkan situs atau situs dinonaktifkan karena batas Penggunaan yang Anda konfigurasikan telah tercapai.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "",
  "PageNumber": 0,
  "PageSize": 0,
  "TotalCount": 0,
  "Sites": [
    {
      "AccessType": "",
      "CnameZone": "",
      "Coverage": "",
      "CreateTime": "",
      "UpdateTime": "",
      "InstanceId": "",
      "NameServerList": "",
      "PlanName": "",
      "PlanSpecName": "",
      "ResourceGroupId": "",
      "SiteId": 0,
      "SiteName": "",
      "Status": "",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "VerifyCode": "",
      "VisitTime": "",
      "OfflineReason": ""
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.