ListOriginPools - Edge Security Acceleration - Alibaba Cloud Documentation Center

Mencantumkan semua origin pool di dalam sebuah site. Mendukung paginasi dan pencarian berdasarkan nama origin pool (pencocokan tepat atau fuzzy).

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:ListOriginPools

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 1 hingga 500. Jika Anda menentukan nilai yang lebih besar dari 500, sistem akan menggunakan 500.	20
Name	string	No	Nama origin pool.	pool1
MatchType	string	No	Menentukan cara mencocokkan nama origin pool. Nilai default: `exact`. Nilai yang valid: `fuzzy`: melakukan pencocokan fuzzy. `exact`: melakukan pencocokan tepat.	exact
OrderBy	string	No	Menentukan cara hasil diurutkan. Secara default, hasil diurutkan berdasarkan ID dalam urutan menurun. Untuk mengurutkan berdasarkan ID dalam urutan menaik, atur parameter ini ke `id`. ID meningkat sesuai dengan waktu pembuatan. id: mengurutkan berdasarkan ID dalam urutan menurun. id: mengurutkan berdasarkan ID dalam urutan menaik.	id
SiteId	integer	Yes	ID site. Untuk memperoleh ID, panggil operasi ListSites.	151538882642832

Elemen respons

Element	Type	Description	Example
	object	Skema respons.
RequestId	string	ID permintaan.	15C66C7B-671A-4297-9187-2C4477247A74
OriginPools	array<object>	Daftar origin pool.
	array<object>	Sebuah origin pool.
Id	integer	ID origin pool.	1038520525196928
Name	string	Nama origin pool. Nama harus unik di dalam sebuah site.	pool1
SiteId	integer	ID site tempat origin pool berada.	216558609793952
RecordName	string	Nama domain yang ditetapkan untuk origin pool. Dapat digunakan sebagai alamat origin untuk record di dalam site.	pool1.example.com
Enabled	boolean	Menunjukkan apakah origin pool diaktifkan. `true`: diaktifkan. `false`: dinonaktifkan.	false
References	object	Sumber daya yang mereferensikan origin pool ini. Sebuah origin pool dianggap direferensikan ketika dikonfigurasi sebagai origin untuk load balancer atau record.
LoadBalancers	array<object>	A list of load balancers that use this origin pool.
	object	Details about a load balancer that uses this origin pool.
Name	string	The name of the load balancer.	lb1.example.com
Id	integer	The ID of the load balancer.	998740660522624
DnsRecords	array<object>	A list of Layer 7 records that use this origin pool as their origin.
	object	Details about a Layer 7 record that uses this origin pool as its origin.
Name	string	The name of the record.	www.example.com
Id	integer	The ID of the record.	1042852886352704
IPARecords	array<object>	A list of Layer 4 records that use this origin pool as their origin.
	object	Details about a Layer 4 record that uses this origin pool as its origin.
Name	string	The name of the record.	ipa.example.com
Id	integer	The ID of the record.	1042852886352704
ReferenceLBCount	integer	Jumlah load balancer yang mereferensikan origin pool ini.	5
Origins	array<object>	Origin-origin di dalam origin pool.
	array<object>	Sebuah origin di dalam origin pool.
Id	integer	The ID of the origin.	997502094872132
Name	string	The name of the origin.	origin1
Address	string	The origin address, such as `www.example.com`.	www.example.com
Enabled	boolean	Indicates whether the origin is enabled: `true`: Enabled. `false`: Disabled.	true
Weight	integer	The weight of the origin. Must be an integer from 0 to 100.	50
Type	string	The type of the origin: `ip_domain`: The origin is an IP address or domain name. `OSS`: The origin is an OSS bucket. `S3`: The origin is an AWS S3 bucket.	S3
Header	any	The request header sent during an origin-pull. Only the `Host` header is supported.	{ "Host": [ "example.com" ] }
AuthConf	object	Authentication configuration. This is required if the origin, such as an OSS or AWS S3 bucket, requires authentication.
AuthType	string	The authentication type: `public`: Public access. For OSS or AWS S3 buckets that allow public read/write access. `private_same_account`: Private access for an OSS origin within the same account. `private_cross_account`: Private access for an OSS origin across different accounts. `private`: Private access for an AWS S3 origin.	public
AccessKey	string	The AccessKey required for private authentication.	yourAccessKeyID
SecretKey	string	The SecretKey required for private authentication.	yourAccessKeySecret
Version	string	The signature version. Required if the origin is an AWS S3 bucket.	v2
Region	string	The origin region. Required if the origin is an AWS S3 bucket.	us-east-1
IpVersionPolicy	string		round_robin
PageNumber	integer	Nomor halaman saat ini.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	20
TotalCount	integer	Jumlah total origin pool yang ditemukan.	16
TotalPage	integer	Jumlah total halaman.	10

Contoh

Respons sukses

JSONformat

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "OriginPools": [
    {
      "Id": 1038520525196928,
      "Name": "pool1",
      "SiteId": 216558609793952,
      "RecordName": "pool1.example.com\n",
      "Enabled": false,
      "References": {
        "LoadBalancers": [
          {
            "Name": "lb1.example.com\n",
            "Id": 998740660522624
          }
        ],
        "DnsRecords": [
          {
            "Name": "www.example.com\n",
            "Id": 1042852886352704
          }
        ],
        "IPARecords": [
          {
            "Name": "ipa.example.com\n",
            "Id": 1042852886352704
          }
        ]
      },
      "ReferenceLBCount": 5,
      "Origins": [
        {
          "Id": 997502094872132,
          "Name": "origin1",
          "Address": "www.example.com",
          "Enabled": true,
          "Weight": 50,
          "Type": "S3",
          "Header": "{\n        \"Host\": [\n          \"example.com\"\n        ]\n      }",
          "AuthConf": {
            "AuthType": "public",
            "AccessKey": "yourAccessKeyID",
            "SecretKey": "yourAccessKeySecret",
            "Version": "v2",
            "Region": "us-east-1\n"
          },
          "IpVersionPolicy": "round_robin"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 16,
  "TotalPage": 10
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.Coverage	The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.
404	SiteNotFound	The website does not exist or does not belong to you.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.