ListMetaEntities - 查詢中繼資料實體列表 -

查詢中繼資料實體列表-當前僅支援純自訂類型

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
EntityType	string	是	實體類型	custom_entity-customer_api
MaxResults	integer	否	每頁返回的最大結果數，預設為 10，最大 100	10
NextToken	string	否	下一頁遊標，首次請求不傳，後續請求使用上一次返回的 NextToken	AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN
Name	string	否	實體名稱過濾，關鍵詞包含匹配	xm_create_test
Comment	string	否	注釋過濾，分詞匹配	this is a comment
AttributeFilters	array<object>	否	實體屬性過濾條件，多個過濾條件之間為 AND 關係，同一過濾條件內多個值為 OR 關係	[]
	object	否	實體屬性過濾
Key	string	是	過濾屬性 Key	key1
Values	array	否	過濾屬性值列表
	string	否	過濾屬性值	value1
CustomAttributeFilters	array<object>	否	自訂屬性過濾條件，多個過濾條件之間為 AND 關係，同一過濾條件內多個值為 OR 關係,僅支援 ENUM 自訂屬性	[]
	object	否	自訂屬性過濾
Key	string	是	過濾屬性 Key	custom_attr_1
Values	array	否	過濾屬性值列表
	string	否	過濾屬性值	value1
SortBy	string	否	排序欄位	Name
Order	string	否	排序方向	Asc

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	RequestId	ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
Success	boolean	請求是否成功	true
PagingInfo	object	分頁資訊
TotalCount	integer	總數	10
MaxResults	integer	每頁返回的最大結果數	10
NextToken	string	下一頁遊標	AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=
MetaEntities	array	自訂實體列表
	MetaEntity	自訂實體物件

樣本

正常返回樣本

JSON格式

{
  "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"
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。