全部產品
Search
文件中心

Data Transmission Service:新增訂閱任務的消費組

更新時間:Feb 10, 2025

調用CreateConsumerChannel介面為DTS訂閱任務新增消費組,用於下遊用戶端消費訂閱資料。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String CreateConsumerChannel

系統規定參數,取值:CreateConsumerChannel

ConsumerGroupName String 訂閱組A

消費組的名稱,不超過128個字元。建議配置具有業務意義的名稱,便於後續識別。

ConsumerGroupPassword String Test123456

消費組的帳號密碼。

  • 由大寫字母、小寫字母、數字、特殊字元中的任意兩種或兩種以上組成。
  • 密碼長度為8~32個字元。
ConsumerGroupUserName String dtstest

消費組的帳號。

  • 由大寫字母、小寫字母、數字、底線中的任意一種或多種組成。
  • 最長16個字元。
RegionId String cn-hangzhou

DTS訂閱執行個體所在地區的ID,請參見支援的地區列表

DtsInstanceId String dtsboss6pn1w******

訂閱執行個體ID,可以調用DescribeDtsJobs查詢。

說明 參數DtsInstanceIdDtsJobId,兩者必須傳入其一。
DtsJobId String boss6pn1w******

訂閱任務ID,可以調用DescribeDtsJobs查詢。

說明 參數DtsInstanceIdDtsJobId,兩者必須傳入其一。

返回資料

名稱 類型 樣本值 描述
ConsumerGroupID String dtsor2y66j4219****

消費組ID,可在下遊用戶端消費訂閱資料時傳入。

ErrCode String InternalError

調用出錯時返回的錯誤碼。

ErrMessage String The request processing has failed due to some unknown error.

調用出錯時返回對應的錯誤資訊。

HttpStatusCode String 200

狀態代碼。

RequestId String 5F566C5B-E5B0-4020-A531-FC6F5005****

請求ID。

Success String true

請求是否成功。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=CreateConsumerChannel
&ConsumerGroupName=訂閱組A
&ConsumerGroupPassword=Test123456
&ConsumerGroupUserName=dtstest
&RegionId=cn-hangzhou
&DtsInstanceId=dtsboss6pn1w******

正常返回樣本

XML格式

<CreateConsumerChannelResponse>
      <ConsumerGroupID>dtsor2y66j4219****</ConsumerGroupID>
      <RequestId>5F566C5B-E5B0-4020-A531-FC6F5005****</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</CreateConsumerChannelResponse>

JSON格式

{
	"ConsumerGroupID": "dtsor2y66j4219****",
	"RequestId": "5F566C5B-E5B0-4020-A531-FC6F5005****",
	"HttpStatusCode": 200,
	"Success": true
}

錯誤碼

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