GetDigitalEmployeeEntityData - STAROps

查詢數位員工的 Entity 資料。

介面說明

查詢數位員工的 Entity 資料。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

starops:GetDigitalEmployeeEntityData

get

*DigitalEmployee

acs:starops:{#regionId}:{#accountId}:digitalemployee/{#name}

無

請求文法

POST /digitalEmployee/{name}/entities/query HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
name	string	是	需要查詢 Entity 資料的數位員工名稱。	sample-agent

請求參數

名稱	類型	必填	描述	樣本值
body	object	否	查詢主體最大 4 MiB。查詢由數位員工的內部資源執行，無需提供內部儲存識別碼。
from	integer	是	Unix 時間戳記，單位為秒。	1770000000
query	string	是	僅允許查詢目前數位員工的 .entity 或 .topo 語意來源，禁止顯式存取內部儲存或外部資料來源。	.entity with(type='deployment', domain='k8s') \| limit 100
to	integer	是	Unix 時間戳記，單位為秒，必須大於 from。	1770003600

返回參數

名稱	類型	描述	樣本值
	object	介面傳回資料。
data	array	二維陣列形式的查詢結果；每個儲存格以字串傳回。
	array	清單項目。
	string	清單項目。	example
header	array	查詢結果每一欄的名稱。
	string	清單項目。	example
requestId	string	由 STAROps 接入層產生的本次請求唯一識別碼。	0A1B2C3D-4E5F-6789-ABCD-1234567890AB
responseStatus	object	查詢的完成情況、重試建議和執行狀態。
level	string	狀態層級。枚舉值： Error : 錯誤資訊。 Info : 資訊提示。 Warn : 警告資訊。	Info
result	string	查詢結果狀態。枚舉值： Error : 失敗。 PartialSuccess : 部分成功。 Success : 成功。	Success
retryPolicy	string	重試建議。枚舉值： Once : 建議重試一次。 Continuous : 可持續重試。 None : 不建議重試。	None
statusItem	array<object>	狀態詳細資料清單。
	object	清單項目。
code	string	狀態碼。	Success
level	string	狀態層級。	example
message	string	狀態資訊。	success
suggestion	string	處理建議。	example

樣本

正常返回樣本

JSON格式

{
  "data": [
    [
      "example"
    ]
  ],
  "header": [
    "example"
  ],
  "requestId": "0A1B2C3D-4E5F-6789-ABCD-1234567890AB",
  "responseStatus": {
    "level": "Info",
    "result": "Success",
    "retryPolicy": "None",
    "statusItem": [
      {
        "code": "Success",
        "level": "example",
        "message": "success",
        "suggestion": "example"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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