All Products
Search

This Product

    ApsaraMQ for MQTT:QueryCustomAuthPermission

    Document Center

    ApsaraMQ for MQTT:QueryCustomAuthPermission

    Last Updated:Dec 21, 2025

    Mengambil informasi otorisasi untuk suatu topik.

    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

    mq:QueryCustomAuthPermission

    get

    *Instance

    acs:mq:{#regionId}:{#accountId}:{#InstanceId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    ID instans ApsaraMQ for MQTT.

    post-cn-0pp12gl****
    IdentityType

    string

    No

    Tipe identitas.

    USER
    Identity

    string

    No

    Username atau client ID.

    test
    Topic

    string

    No

    Topik yang informasi otorisasinya ingin Anda tanyakan. Topik multi-level dan karakter wildcard didukung.

    test
    NextToken

    string

    No

    Token yang menandai posisi akhir dari halaman hasil sebelumnya. Untuk memperoleh batch data berikutnya, panggil kembali operasi ini dengan menggunakan nilai NextToken yang dikembalikan oleh permintaan sebelumnya. Jika Anda memanggil operasi ini untuk pertama kalinya atau ingin menanyakan semua hasil, atur NextToken ke string kosong.

    AAAAAThmKW2HkRgzo4G7IRRTK2fC6zZmAk6y0bwoNPFOOcSP
    Size

    integer

    Yes

    Jumlah hasil yang akan dikembalikan. Nilai maksimum: 100.

    100

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema respons.

    RequestId

    string

    ID permintaan.

    63309FDB-ED6C-46AE-B31C-A172FBA0****
    Code

    integer

    Kode status HTTP.

    200
    Success

    boolean

    Menunjukkan apakah permintaan berhasil. Nilai yang valid: true dan false.

    True
    Message

    string

    Pesan yang dikembalikan.

    operation success.
    Data

    object

    Data yang dikembalikan.

    Results

    array<object>

    Hasil respons.

    object

    Identity

    string

    Username atau client ID.

    test
    PermitAction

    string

    Izin yang diberikan.

    PUB_SUB
    Effect

    string

    Menunjukkan apakah akses diizinkan atau ditolak.

    ALLOW
    IdentityType

    string

    Tipe identitas. Nilai yang valid:

    • USER

    • CLIENT

    USER
    Topic

    string

    Nama topik. Topik multi-level dan karakter wildcard didukung.

    test
    NextToken

    string

    Token yang menandai posisi akhir dari halaman hasil sebelumnya. Untuk memperoleh batch data berikutnya, panggil kembali operasi ini dengan menggunakan nilai NextToken yang dikembalikan oleh permintaan sebelumnya. Jika Anda memanggil operasi ini untuk pertama kalinya atau ingin menanyakan semua hasil, atur NextToken ke string kosong.

    AAAAAV/vsqTyeMlX1MIk7/b6NrZLIlsSVf49O04ac7HAmlBoaYspakK7ZZkR3vRDp5Y9Nz0EmuWYrtF+1qkUwuJzPk/qEto/FGxl5Kd+qdwNt3t8

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "63309FDB-ED6C-46AE-B31C-A172FBA0****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "Identity": "test",
        "PermitAction": "PUB_SUB",
        "Effect": "ALLOW",
        "IdentityType": "USER",
        "Topic": "test"
      }
    ],
    "NextToken": "AAAAAV/vsqTyeMlX1MIk7/b6NrZLIlsSVf49O04ac7HAmlBoaYspakK7ZZkR3vRDp5Y9Nz0EmuWYrtF+1qkUwuJzPk/qEto/FGxl5Kd+qdwNt3t8"
  }
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InstancePermissionCheckFailed An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
    400 InvalidParameter.%s An error occurred while validating the parameter. The parameter may be missing or invalid.
    404 ApiNotSupport The specified API is not supported.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.