Mencantumkan entitas metadata. Dukungan saat ini terbatas pada tipe kustom.
Coba sekarang
Test
RAM authorization
Sintaks permintaan
POST HTTP/1.1
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| EntityType |
string |
Yes |
Tipe entitas yang akan didaftarkan. |
custom_entity-customer_api |
| MaxResults |
integer |
No |
Jumlah maksimum hasil yang dikembalikan per halaman. Nilai default: 10. Nilai maksimum: 100. |
10 |
| NextToken |
string |
No |
Token pagination yang menentukan halaman hasil berikutnya. Untuk mengambil halaman pertama, jangan tentukan parameter ini. Untuk mengambil halaman berikutnya, tetapkan parameter ini ke nilai |
AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN |
| Name |
string |
No |
Memfilter entitas berdasarkan nama. Pencocokan ini bersifat pencocokan substring. |
xm_create_test |
| Comment |
string |
No |
Memfilter entitas berdasarkan komentar. Pencocokan ini berbasis token. |
this is a comment |
| AttributeFilters |
array<object> |
No |
Kondisi untuk memfilter entitas berdasarkan atribut entitas. Operator |
[] |
|
object |
No |
A single filter condition for an entity attribute. |
||
| Key |
string |
Yes |
The key of the entity attribute to filter by. |
key1 |
| Values |
array |
No |
A list of values for the specified entity attribute. |
|
|
string |
No |
A value for the entity attribute. |
value1 |
|
| CustomAttributeFilters |
array<object> |
No |
Kondisi untuk memfilter entitas berdasarkan atribut kustom. Operator |
[] |
|
object |
No |
A single filter condition for a custom attribute. |
||
| Key |
string |
Yes |
The key of the custom attribute to filter by. |
custom_attr_1 |
| Values |
array |
No |
A list of values for the specified custom attribute. |
|
|
string |
No |
A value for the custom attribute. |
value1 |
|
| SortBy |
string |
No |
Bidang yang digunakan untuk Pengurutan hasil. |
Name |
| Order |
string |
No |
Pesanan pengurutan. Nilai valid: |
Asc |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
The response schema. |
||
| RequestId |
string |
The request ID. |
ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS |
| Success |
boolean |
Indicates whether the request succeeded. |
true |
| PagingInfo |
object |
Pagination information. |
|
| TotalCount |
integer |
The total number of entries. |
10 |
| MaxResults |
integer |
The maximum number of entries per page. |
10 |
| NextToken |
string |
The token used to retrieve the next page of results. If this parameter is empty, no more results are available. |
AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc= |
| MetaEntities |
array |
A list of metadata entities. |
|
| MetaEntity |
A metadata entity object. |
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": "",
"OwnerId": "",
"CustomAttributes": {
"key": [
"张三"
]
},
"MetaEntityDef": {
"Name": "customer_api",
"EntityType": "custom_entity-customer_api",
"DisplayName": "",
"Description": "",
"AttributeDefs": [
{
"Name": "apiCode",
"DisplayName": "API编码",
"Type": "STRING",
"IsOptional": true,
"SearchFilterEnabled": false,
"DisplayEnabled": true,
"AllowedValues": [
"LABEL_1"
],
"Description": "层级描述"
}
],
"Extend": "NONE",
"CreateTime": 0,
"ModifyTime": 0
},
"CreateTime": 0,
"ModifyTime": 0,
"Attributes": {
"key": ""
}
}
]
}
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.