調用ConfigureSubscription接口配置DTS訂閱任務。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | ConfigureSubscription | 系統規定參數。取值:ConfigureSubscription。 |
RegionId | String | 是 | cn-hangzhou | 訂閱實例所在地域,請參見支持的地域列表。 |
DtsJobName | String | 是 | MySQL訂閱 | 訂閱任務名稱。 說明 建議配置具有業務意義的名稱(無唯一性要求),便于后續識別。 |
DtsInstanceId | String | 否 | dtsy0zz3t13h7d**** | 訂閱實例ID,可以調用DescribeDtsJobs查詢。 |
DtsJobId | String | 否 | y0zz3t13h7d**** | 訂閱任務ID,可以調用DescribeDtsJobs查詢。 |
SourceEndpointEngineName | String | 否 | PostgreSQL | 源數據庫類型,取值為MySQL、PostgreSQL、Oracle。 說明 當源數據庫為自建數據庫,本參數必須傳入。 |
SourceEndpointInstanceType | String | 否 | RDS | 源數據庫的實例類型,取值:
|
SourceEndpointRegion | String | 否 | cn-hangzhou | 源實例所屬地域,詳情請參見支持的地域列表。 說明 如果源實例為有公網IP的自建數據庫,則可以傳入cn-hangzhou或者離自建數據庫物理距離最近的區域ID。 |
SourceEndpointInstanceID | String | 否 | rm-bp1zc3iyqe3qw**** | 源實例ID。 說明 源數據庫的實例類型為RDS MySQL、PolarDB-X 1.0、PolarDB MySQL時,本參數才可用且必須傳入。 |
SourceEndpointIP | String | 否 | 172.16.8*.*** | 源數據庫的連接地址。 說明 當源數據庫為自建數據庫時,本參數才可用且必須傳入。 |
SourceEndpointPort | String | 否 | 3306 | 源數據庫的服務端口。 說明 當源數據庫為自建數據庫時,本參數才可用且必須傳入。 |
SourceEndpointOracleSID | String | 否 | testsid | Oracle數據庫的SID信息。 說明 當源數據庫為自建Oracle時,且Oracle數據庫為非RAC實例時,本參數才可用且必須傳入。 |
SourceEndpointDatabaseName | String | 否 | dtstestdata | 待訂閱的數據庫名稱。 |
SourceEndpointUserName | String | 否 | dtstest | 源實例的數據庫賬號。 說明 訂閱不同的數據庫所需的權限有所差異,請參見準備用于數據訂閱的數據庫賬號中的賬號權限。 |
SourceEndpointPassword | String | 否 | Test123456 | 源實例的數據庫賬號密碼。 |
SourceEndpointOwnerID | String | 否 | 140692647406**** | 源實例所屬的阿里云賬號ID。 說明 僅在配置跨阿里云賬號的數據訂閱時本參數才可用,且必須傳入。 |
SourceEndpointRole | String | 否 | ram-for-dts | 源實例的授權角色。當源實例與配置訂閱任務所屬阿里云賬號不同時,需傳入該參數,來指定源實例的授權角色,以允許配置訂閱任務所屬阿里云賬號訪問源實例的實例信息。 說明 角色所需的權限及授權方式,請參見跨阿里云賬號數據遷移或同步時如何配置RAM授權。 |
DbList | String | 是 | {"dtstest":{"name":"dtstest","all":true}} | 訂閱對象,格式為JSON串。詳細定義,請參見遷移、同步或訂閱對象說明。 |
Reserve | String | 否 | { "srcInstanceId": "cen-9kqshqum*******" } | DTS預留參數,格式為JSON串,您可以傳入本參數完善源目庫信息(如目標Kafka數據庫的數據存儲格式、云企業網CEN的實例ID)。更多信息,請參見Reserve參數說明參數說明。 |
Checkpoint | String | 否 | 1616902385 | 訂閱啟動時間,格式為Unix時間戳,單位為秒(s)。 說明 Unix時間戳轉換工具可用搜索引擎獲取。 |
SubscriptionInstanceNetworkType | String | 是 | vpc | 訂閱任務的網絡類型,目前取值僅支持vpc,表示專有網絡。 說明
|
SubscriptionInstanceVPCId | String | 否 | vpc-bp1vwnn14rqpyiczj**** | 訂閱實例的專有網絡ID。 說明 當SubscriptionInstanceNetworkType取值為vpc時,本參數才可用且必須傳入。 |
SubscriptionInstanceVSwitchId | String | 否 | vsw-bp10df3mxae6lpmku**** | 訂閱實例的虛擬交換機ID。 說明 當SubscriptionInstanceNetworkType取值為vpc時,本參數才可用且必須傳入。 |
SubscriptionDataTypeDDL | Boolean | 否 | true | 是否訂閱DDL類型的數據,取值:
|
SubscriptionDataTypeDML | Boolean | 否 | true | 是否訂閱DML類型的數據,取值:
|
DelayPhone | String | 否 | 1361234****,1371234**** | 延遲報警的聯系人手機號碼,多個手機號碼以英文逗號(,)分隔。 說明
|
DelayRuleTime | Long | 否 | 10 | 觸發延遲報警的閾值,單位為秒且需為整數,可根據業務需要設置閾值,建議設置10秒以上,避免因網絡、數據庫負載等原因導致的延遲波動。 說明 當DelayNotice取值為true時,本參數必須傳入。 |
DelayNotice | Boolean | 否 | true | 是否監控延遲狀態,取值:
|
ErrorPhone | String | 否 | 1361234****,1371234**** | 異常報警的聯系人手機號碼,多個手機號碼以英文逗號(,)分隔。 說明
|
ErrorNotice | Boolean | 否 | true | 是否監控異常狀態,取值:
|
DedicatedClusterId | String | 否 | dtscluster_atyl3b5214uk*** | DTS專屬集群ID,用于將訂閱任務調度到指定的DTS專屬集群上。 |
DtsBisLabel | String | 否 | normal | DTS實例的環境標簽,取值為:
|
MinDu | double | 否 | 1 | Serverless實例的DU下限,取值為:1、2、4、8、16。 |
MaxDu | double | 否 | 16 | Serverless實例的DU上限,取值為:2、4、8、16。 |
SrcCaCertificateOssUrl | String | 否 | **** | 源庫通過SSL安全連接時,CA證書的路徑。 說明 當前暫不支持此功能,請勿傳入此參數。 |
SrcCaCertificatePassword | String | 否 | **** | 源庫通過SSL安全連接時,CA證書的密鑰。 說明 當前暫不支持此功能,請勿傳入此參數。 |
SrcClientCertOssUrl | String | 否 | **** | 源庫通過SSL安全連接時,客戶端證書的路徑。 說明 當前暫不支持此功能,請勿傳入此參數。 |
SrcClientKeyOssUrl | String | 否 | **** | 源庫通過SSL安全連接時,客戶端證書私鑰的路徑。 說明 當前暫不支持此功能,請勿傳入此參數。 |
SrcClientPassword | String | 否 | **** | 源庫通過SSL安全連接時,客戶端證書私鑰的密碼。 說明 當前暫不支持此功能,請勿傳入此參數。 |
ResourceGroupId | String | 否 | rg-acfmzawhxxc**** | 資源組ID。 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
HttpStatusCode | String | 200 | 狀態碼。 |
RequestId | String | 1D6ECADF-C5E9-4C96-8811-77602B31**** | 請求ID。 |
ErrCode | String | InternalError | 調用出錯時返回的錯誤碼。 |
DtsJobId | String | y0zz3t13h7d**** | 訂閱任務ID。 |
Success | String | true | 請求是否成功。 |
DtsInstanceId | String | dtsy0zz3t13h7d**** | 訂閱實例ID。 |
ErrMessage | String | The request processing has failed due to some unknown error. | 調用出錯時返回對應的錯誤信息。 |
示例
請求示例
http(s)://dts.aliyuncs.com/?Action=ConfigureSubscription
&DbList={"dtstest":{"name":"dtstest","all":true}}
&DtsJobName=MySQL訂閱
&SourceEndpointInstanceType=RDS
&SubscriptionInstanceNetworkType=vpc
&SourceEndpointInstanceID=rm-bp1zc3iyqe3qw****
&SourceEndpointUserName=dtstest
&SourceEndpointPassword=Test123456
&<公共請求參數>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ConfigureSubscriptionResponse>
<DtsJobId>y0zz3t13h7d****</DtsJobId>
<RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<DtsInstanceId>dtsy0zz3t13h7d****</DtsInstanceId>
<Success>true</Success>
</ConfigureSubscriptionResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DtsJobId" : "y0zz3t13h7d****",
"RequestId" : "1D6ECADF-C5E9-4C96-8811-77602B31****",
"HttpStatusCode" : 200,
"DtsInstanceId" : "dtsy0zz3t13h7d****",
"Success" : true
}
錯誤碼
HttpCode |
錯誤碼 |
錯誤信息 |
描述 |
400 | Throttling.User | Request was denied due to user flow control. | 由于請求頻次達到閾值,請求被拒絕,請稍后重試。 |
500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 由于服務端響應超時或者不可用導致請求失敗,請重試,重試后仍失敗請聯系技術支持。 |
403 | InvalidSecurityToken.Expired | Specified SecurityToken is expired. | 簽名已經過期,請更新簽名 |
訪問錯誤中心查看更多錯誤碼。