ListMetaEntities - DataWorks - Alibaba Cloud Documentation Center

Mengambil daftar entitas metadata. Saat ini, hanya tipe entitas kustom yang didukung.

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

dataworks:ListMetaEntities

list

*All Resource

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
EntityType	string	Yes	Tipe entitas.	custom_entity-customer_api
MaxResults	integer	No	Jumlah maksimum hasil per halaman. Nilai default: 10. Nilai maksimum: 100.	10
NextToken	string	No	Token pagination. Jangan tentukan parameter ini untuk permintaan pertama. Untuk permintaan berikutnya, gunakan nilai NextToken yang dikembalikan dalam respons sebelumnya.	AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN
Name	string	No	Filter nama entitas. Melakukan pencocokan berdasarkan kata kunci (contains).	xm_create_test
Comment	string	No	Filter komentar. Melakukan pencocokan berdasarkan token.	this is a comment
AttributeFilters	array<object>	No	Kondisi filter atribut entitas. Beberapa kondisi filter memiliki hubungan AND. Beberapa nilai dalam satu kondisi filter memiliki hubungan OR.	[]
	object	No	Filter atribut entitas.
Key	string	Yes	Kunci atribut filter.	key1
Values	array	No	Daftar nilai atribut filter.
	string	No	Nilai atribut filter.	value1
CustomAttributeFilters	array<object>	No	Kondisi filter atribut kustom. Beberapa kondisi filter memiliki hubungan AND. Beberapa nilai dalam satu kondisi filter memiliki hubungan OR. Hanya atribut kustom bertipe ENUM yang didukung.	[]
	object	No	Filter atribut kustom.
Key	string	Yes	Kunci atribut filter.	custom_attr_1
Values	array	No	Daftar nilai atribut filter.
	string	No	Nilai atribut filter.	value1
SortBy	string	No	Bidang pengurutan. Valid values: ModifyTime : urutkan berdasarkan waktu modifikasi. CreateTime : urutkan berdasarkan waktu pembuatan. Name : urutkan berdasarkan nama.	Name
Order	string	No	Arah pengurutan. Valid values: Asc : urutan menaik. Desc : urutan menurun.	Asc

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan.	ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
PagingInfo	object	Informasi pagination.
TotalCount	integer	Jumlah total entri.	10
MaxResults	integer	Jumlah maksimum hasil per halaman.	10
NextToken	string	Token pagination untuk halaman berikutnya.	AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=
MetaEntities	array	Daftar entitas kustom.
	MetaEntity	Objek entitas kustom.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "MaxResults": 10,
    "NextToken": "AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=",
    "MetaEntities": [
      {
        "Id": "custom_entity-customer_api:api_001",
        "EntityType": "custom_entity-customer_api",
        "Name": "api_001",
        "Comment": "this is a comment",
        "OwnerId": "207924799988354",
        "CustomAttributes": {
          "key": [
            "张三"
          ]
        },
        "MetaEntityDef": {
          "Name": "biz_api",
          "EntityType": "custom_entity-biz_api",
          "DisplayName": "业务API",
          "Description": "test",
          "AttributeDefs": [
            {
              "Name": "apiCode",
              "DisplayName": "API编码",
              "Type": "STRING",
              "IsOptional": true,
              "SearchFilterEnabled": false,
              "DisplayEnabled": true,
              "AllowedValues": [
                "LABEL_1"
              ],
              "Description": "层级描述"
            }
          ],
          "Extend": "NONE",
          "CreateTime": 1780553640613,
          "ModifyTime": 1780553640613
        },
        "CreateTime": 1780553640613,
        "ModifyTime": 1763380628000,
        "Attributes": {
          "key": "v1"
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.