All Products
Search

This Product

    Anti-DDoS:DescribeInstances

    Document Center

    Anti-DDoS:DescribeInstances

    Last Updated:Jun 10, 2026

    Mengambil daftar instans Anti-DDoS Proxy.

    Deskripsi operasi

    Use this operation to retrieve paginated details for Anti-DDoS instances in your Alibaba Cloud account. The response includes the instance ID, version, expiration time, and service traffic forwarding status.

    QPS limit

    This operation is limited to 10 calls per second per user. Exceeding this limit triggers throttling, which can disrupt your services.

    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

    yundun-ddoscoo:DescribeInstances

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ResourceGroupId

    string

    No

    ID kelompok sumber daya tempat instans Anti-DDoS Proxy berada di Resource Management.

    Jika Anda menghilangkan parameter ini, sistem menggunakan kelompok sumber daya default.

    rg-acfm2pz25js****
    PageNumber

    string

    Yes

    Nomor halaman yang dikembalikan. Halaman dimulai dari 1.

    1
    PageSize

    string

    Yes

    Jumlah instans yang dikembalikan per halaman. Nilai valid: 1 hingga 50.

    10
    Ip

    string

    No

    Alamat IP instans Anti-DDoS Proxy.

    203.107.XX.XX
    Remark

    string

    No

    Keterangan instans Anti-DDoS Proxy. Pencocokan fuzzy didukung.

    doc-test
    Edition

    integer

    No

    Edisi instans Anti-DDoS Proxy. Nilai valid:

    • 0: Anti-DDoS Proxy (Outside Chinese Mainland) Asuransi.

    • 1: Anti-DDoS Proxy (Outside Chinese Mainland) Tanpa Batas.

    • 2: Anti-DDoS Proxy (Outside Chinese Mainland) CMA.

    • 9: Anti-DDoS Proxy (Chinese Mainland) Edisi Profesional.

    9
    Enabled

    integer

    No

    Status penerusan lalu lintas layanan instans Anti-DDoS Proxy. Nilai valid:

    • 0: Penerusan trafik dihentikan.

    • 1: Trafik diteruskan.

    1
    ExpireStartTime

    integer

    No

    Awal rentang pengatur waktu kedaluwarsa yang akan dikueri. Operasi ini hanya mengembalikan instans yang kedaluwarsa setelah pengatur waktu ini. Nilainya adalah stempel waktu UNIX dalam milidetik.

    1640361500000
    ExpireEndTime

    integer

    No

    Akhir rentang pengatur waktu kedaluwarsa yang akan dikueri. Operasi ini hanya mengembalikan instans yang kedaluwarsa pada atau sebelum pengatur waktu ini. Nilainya adalah stempel waktu UNIX dalam milidetik.

    1640361700000
    InstanceIds

    array

    No

    Array ID instans Anti-DDoS Proxy. Anda dapat menentukan hingga 200 ID instans.

    string

    No

    The ID of an Anti-DDoS Proxy instance.

    ddoscoo-cn-7pp2g9ed****
    Status

    array

    No

    Array status instans untuk pemfilteran. Anda dapat menentukan hingga dua status.

    integer

    No

    The status of the Anti-DDoS Proxy instance. Valid values:

    • 1: Normal.

    • 2: Expired.

    1
    Tag

    array<object>

    No

    Array tag untuk memfilter instans.

    object

    No

    Key

    string

    No

    The tag key used for filtering. You can specify up to 200 tags.

    • A tag is a key-value pair defined by a tag key (Key) and a tag value (Value).

    • You can use tags to filter instances.

    Catatan

    The Key and Value parameters for a tag must be specified as a pair.

    test-key
    Value

    string

    No

    The tag value used for filtering. You can specify up to 200 tags.

    • A tag is a key-value pair defined by a tag key (Key) and a tag value (Value).

    • You can use tags to filter instances.

    Catatan

    The Key and Value parameters for a tag must be specified as a pair.

    test-value

    Saat Anda memanggil API ini, Anda harus menyertakan parameter permintaan khusus API dan parameter permintaan umum Alibaba Cloud. Untuk informasi selengkapnya, lihat Common parameters.

    Untuk format permintaan, lihat contoh permintaan di bagian Examples.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of instances found.

    1
    RequestId

    string

    The request ID. Alibaba Cloud generates this unique ID for the request. Use it to locate and troubleshoot issues.

    A0AF40CC-814A-5A86-AEAA-6F19E88B8A39
    Instances

    array<object>

    A list of instance details.

    object

    Status

    integer

    The status of the instance. Valid values:

    • 1: Normal

    • 2: Expired

    1
    IpMode

    string

    The IP forwarding mode of the instance. Valid values:

    • fnat: The IP versions of the client and the origin server are the same. For example, requests from IPv4 clients are forwarded to IPv4 origin servers, and requests from IPv6 clients are forwarded to IPv6 origin servers.

    • v6tov4: Requests from IPv6 clients are forwarded to IPv4 origin servers.

    fnat
    DebtStatus

    integer

    The overdue payment status of the instance. The value is fixed at 0, which indicates no overdue payment. This is because both Anti-DDoS Pro (Chinese Mainland) and Anti-DDoS Proxy (Outside Chinese Mainland) are subscription-based.

    0
    Edition

    integer

    The edition of the instance. Valid values:

    • 0: Anti-DDoS Proxy (Outside Chinese Mainland) Insurance

    • 1: Anti-DDoS Proxy (Outside Chinese Mainland) Unlimited

    • 2: Anti-DDoS Proxy (Outside Chinese Mainland) CMA

    • 9: Anti-DDoS Pro (Chinese Mainland) Professional Edition

    9
    IpVersion

    string

    The IP protocol version of the instance. Valid values:

    • Ipv4: IPv4

    • Ipv6: IPv6

    Ipv4
    ExpireTime

    integer

    The expiration time of the instance, provided as a UNIX timestamp in milliseconds.

    1640361600000
    Remark

    string

    The remark for the instance.

    doc-test
    CreateTime

    integer

    The creation time of the instance, provided as a UNIX timestamp in milliseconds.

    1637751953000
    Enabled

    integer

    The service traffic forwarding status of the instance. Valid values:

    • 0: Service traffic forwarding is stopped.

    • 1: Service traffic forwarding is active.

    1
    InstanceId

    string

    The ID of the instance.

    ddoscoo-cn-7pp2g9ed****
    IsFirstOpenBw

    integer

    Specifies whether the 95th percentile burstable clean bandwidth billing method has been previously enabled. Valid values:

    • 0: No

    • 1: Indicates that it has been enabled.

    0
    IsFirstOpenQps

    integer

    Specifies whether the 95th percentile burstable QPS billing method has been previously enabled. Valid values:

    • 0: No

    • 1: Enabled.

    0
    Ip

    string

    The IP address of the instance.

    203.199.XX.XX

    Contoh

    Respons sukses

    JSONformat

    {
  "TotalCount": 1,
  "RequestId": "A0AF40CC-814A-5A86-AEAA-6F19E88B8A39",
  "Instances": [
    {
      "Status": 1,
      "IpMode": "fnat",
      "DebtStatus": 0,
      "Edition": 9,
      "IpVersion": "Ipv4",
      "ExpireTime": 1640361600000,
      "Remark": "doc-test",
      "CreateTime": 1637751953000,
      "Enabled": 1,
      "InstanceId": "ddoscoo-cn-7pp2g9ed****",
      "IsFirstOpenBw": 0,
      "IsFirstOpenQps": 0,
      "Ip": "203.199.XX.XX"
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.