使用ListStreamingJobs查詢即時資料同步任務-雲原生資料倉儲AnalyticDB-阿里雲

查詢所有即時資料同步任務。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:ListStreamingJobs

delete

*DBInstance

acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。說明您可以調用 DescribeRegions 介面查看可用的地區 ID。	cn-beijing
DBInstanceId	string	是	執行個體 ID。	gp-bp10g78o9807yv9h3
PageSize	integer	否	每頁記錄數，取值說明： 30 50 100 預設值：30。	kafka
PageNumber	integer	否	頁碼，大於 0 且不超過 Integer 的最大值，預設值：1。	1

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
PageNumber	integer	當前頁碼。	1
PageRecordCount	integer	當前頁記錄數。	2
TotalRecordCount	integer	總記錄數。	2
JobItems	array<object>	返回的工作清單。
	object
JobId	string	任務 ID。	1
JobName	string	任務名稱。	test-job
DataSourceId	string	資料來源 ID。	58
JobDescription	string	任務描述。	test job
SrcColumns	array	源端資料欄位列表。
	string	源端資料欄位索引值。	src_column_1
DestColumns	array	目標資料表映射欄位列表。
	string	目標表裡面的映射欄位索引值。	dest_column_1
MatchColumns	array	匹配列，通常為目標表的所有主鍵列，此配置內所有列的值相同即視為兩行資料為重複資料。
	string	匹配欄位索引值。	column_1
UpdateColumns	array	更新列，通常為目標表的所有非主鍵列，當通過 MatchColumns 確定資料重複時，通過更新 UpdateColumns 列的值，產生使新資料覆蓋舊資料的效果。
	string	更新欄位索引值。	column_1
Account	string	帳號名稱。	test-account
Password	string	密碼。	pwd123
DestDatabase	string	目標資料庫名稱。	dest-db
DestSchema	string	目標命名空間。	dest-schema
DestTable	string	目標表名稱。	dest-table
WriteMode	string	寫入模式。	INSERT/UPDATE/MERGE
Mode	string	配置模式 basic 模式需要指定一些配置欄位 professional 支援提交 yaml 檔案	basic / professional
ErrorMessage	string	錯誤資訊。只會在 Status 參數傳回值為 false 時返回該參數。	""
Status	string	服務狀態，取值： Init：初始化中 Running：運行中 Exception：異常 Paused：暫停	Running
CreateTime	string	建立時間。	2019-09-08T16:00:00Z
ModifyTime	string	最後修改時間。	2019-09-08T17:00:00Z
FallbackOffset	string	FallbackOffset 回退點位，回退位移量 FallbackOffset 參數定義了當 consumer 沒有請求需要消費的位點或者請求的消費的位點超出當前 kafka 叢集的記錄的位點資訊的時候的行為。可以選擇從 earliest（最新）或者 latest（最晚）位點開始消費。	EARLIEST / LATEST
Consistency	string	投遞保證。	ATLEAST / EXACTLY
DataSourceName	string	資料來源名稱。	test-kafka

樣本

正常返回樣本

JSON格式

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "PageNumber": 1,
  "PageRecordCount": 2,
  "TotalRecordCount": 2,
  "JobItems": [
    {
      "JobId": "1",
      "JobName": "test-job",
      "DataSourceId": "58",
      "JobDescription": "test job",
      "SrcColumns": [
        "src_column_1"
      ],
      "DestColumns": [
        "dest_column_1"
      ],
      "MatchColumns": [
        "column_1"
      ],
      "UpdateColumns": [
        "column_1"
      ],
      "Account": "test-account",
      "Password": "pwd123",
      "DestDatabase": "dest-db",
      "DestSchema": "dest-schema",
      "DestTable": "dest-table",
      "WriteMode": "INSERT/UPDATE/MERGE",
      "Mode": "basic / professional",
      "ErrorMessage": "\"\"",
      "Status": "Running",
      "CreateTime": "2019-09-08T16:00:00Z",
      "ModifyTime": "2019-09-08T17:00:00Z",
      "FallbackOffset": "EARLIEST /  LATEST",
      "Consistency": "ATLEAST / EXACTLY",
      "DataSourceName": "test-kafka"
    }
  ]
}

錯誤碼

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

變更歷史

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