All Products
Search

This Product

    ApsaraDB for OceanBase (Deprecated):DescribeProxyService

    Document Center

    ApsaraDB for OceanBase (Deprecated):DescribeProxyService

    Last Updated:Jun 12, 2026

    Kueri informasi layanan proxy OceanBase.

    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

    oceanbase:DescribeProxyService

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    ID kluster OceanBase.

    ob317v4uif****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Hasil respons.

    RequestId

    string

    ID Permintaan.

    EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
    Data

    object

    Data yang dikembalikan.

    ProxyClusterId

    string

    ID kluster proxy.

    proxy-3t****zrieasg
    ProxyMode

    string

    Mode proxy.

    shared
    Zone

    string

    Zona ketersediaan.

    cn-shanghai-e,cn-shanghai-f
    UnitSpec

    string

    Spesifikasi unit.

    4C8GB
    UnitNum

    integer

    Jumlah unit.

    1
    CurrentEndpointNum

    integer

    Jumlah endpoint saat ini.

    1
    EndpointNumQuota

    integer

    Kuota jumlah endpoint.

    3
    CreateTime

    string

    Waktu pembuatan.

    2023-07-05T08:23:10Z
    Status

    string

    Status proxy.

    ONLINE
    ProxyServiceVersion

    string

    Versi layanan proxy.

    1.0
    ExpireTime

    string

    Waktu kedaluwarsa.

    2123-07-05T16:00:00
    UnitNumLimit

    integer

    Jumlah maksimum unit.

    4
    ProxyVersion

    string

    Versi proxy database.

    4.3.1.0-xxxxxxxxx
    DeployMode

    string

    ServerNumLimit

    integer

    Jumlah maksimum node.

    AllowModifyServerNum

    boolean

    true: Modifikasi diizinkan, dan jumlah node saat ini ditampilkan. false: Modifikasi tidak diizinkan, dan jumlah node saat ini tidak ditampilkan.

    SharedUnitNumLimit

    integer

    Jumlah maksimum unit untuk layanan proxy mode bersama K8s.

    ExclusiveUnitNumLimit

    integer

    Jumlah maksimum unit untuk layanan proxy mode eksklusif K8s.

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Data": {
    "ProxyClusterId": "proxy-3t****zrieasg",
    "ProxyMode": "shared",
    "Zone": "cn-shanghai-e,cn-shanghai-f",
    "UnitSpec": "4C8GB",
    "UnitNum": 1,
    "CurrentEndpointNum": 1,
    "EndpointNumQuota": 3,
    "CreateTime": "2023-07-05T08:23:10Z",
    "Status": "ONLINE",
    "ProxyServiceVersion": "1.0",
    "ExpireTime": "2123-07-05T16:00:00",
    "UnitNumLimit": 4,
    "ProxyVersion": "4.3.1.0-xxxxxxxxx",
    "DeployMode": "share",
    "ServerNumLimit": 0,
    "AllowModifyServerNum": true,
    "SharedUnitNumLimit": 0,
    "ExclusiveUnitNumLimit": 0
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.