vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

DRS API 2.0.38SP23 version

Browse Source 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
This commit is contained in:
Wang , Deng Ke 2022-11-24 16:49:13 +00:00 committed by zuul
parent 89ea9efbc6
commit 231618c804
81 changed files with 14222 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/drs/api-ref/.placeholder
View File

572
docs/drs/api-ref/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

515
docs/drs/api-ref/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/drs/api-ref/PARAMETERS.txt Normal file
View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

18
docs/drs/api-ref/drs_01_0004.html Normal file
View File

@ -0,0 +1,18 @@
<a name="drs_01_0004"></a><a name="drs_01_0004"></a>
<h1 class="topictitle1">Calling APIs</h1>
<div id="body0000001073160429"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="drs_01_0008.html">Making an API Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_01_0005.html">Authentication</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_01_0007.html">Returned Values</a></strong><br>
</li>
</ul>
</div>

20
docs/drs/api-ref/drs_01_0005.html Normal file
View File

@ -0,0 +1,20 @@
<a name="drs_01_0005"></a><a name="drs_01_0005"></a>
<h1 class="topictitle1">Authentication</h1>
<div id="body0000001073550023"><p id="drs_01_0005__en-us_topic_0117388901_p25348615486">You can use the following authentication method:</p>
<p id="drs_01_0005__en-us_topic_0117388901_p9186192384819">Token authentication: Requests are authenticated using tokens.</p>
<div class="section" id="drs_01_0005__en-us_topic_0117388901_section2474131294916"><h4 class="sectiontitle">Token Authentication</h4><div class="note" id="drs_01_0005__en-us_topic_0117388901_note14844183794912"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="drs_01_0005__en-us_topic_0117388901_p7700627164911">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</p>
</div></div>
<p id="drs_01_0005__en-us_topic_0117388901_p14700132711496">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.</p>
<p id="drs_01_0005__en-us_topic_0117388901_p1700152764914">In section <a href="drs_01_0008.html">3.1 Making an API Request</a>, the process of calling the API used to obtain a user token is described. After a token is obtained, add the <strong id="drs_01_0005__en-us_topic_0117388901_b2081112102311">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <strong id="drs_01_0005__en-us_topic_0117388901_b147531312235">ABCDEFJ....</strong>, <strong id="drs_01_0005__en-us_topic_0117388901_b975412123320">X-Auth-Token: ABCDEFJ....</strong> can be added to a request as follows:</p>
<pre class="screen" id="drs_01_0005__en-us_topic_0117388901_screen19700727194918">GET https://iam.eu-de.otc.t-systems.com/v3/auth/projects
Content-Type: application/json
<strong id="drs_01_0005__en-us_topic_0117388901_b8700927154915">X-Auth-Token: ABCDEFJ....</strong></pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_01_0004.html">Calling APIs</a></div>
</div>
</div>

22
docs/drs/api-ref/drs_01_0006.html Normal file
View File

@ -0,0 +1,22 @@
<a name="drs_01_0006"></a><a name="drs_01_0006"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body0000001073278985"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="drs_api_0109.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0110.html">API Calling</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0111.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0112.html">Constraints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0113.html">Basic Concepts</a></strong><br>
</li>
</ul>
</div>

43
docs/drs/api-ref/drs_01_0007.html Normal file
View File

@ -0,0 +1,43 @@
<a name="drs_01_0007"></a><a name="drs_01_0007"></a>
<h1 class="topictitle1">Returned Values</h1>
<div id="body0000001073398654"><div class="section" id="drs_01_0007__en-us_topic_0117388900_section11248050145310"><h4 class="sectiontitle">Status Code</h4><p id="drs_01_0007__en-us_topic_0117388900_p1032012505539">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
<p id="drs_01_0007__en-us_topic_0117388900_p17320195012538">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="drs_api_0108.html">Status Code</a>.</p>
<p id="drs_01_0007__en-us_topic_0117388900_p5320115045311">For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.</p>
</div>
<div class="section" id="drs_01_0007__en-us_topic_0117388900_section7525122275411"><h4 class="sectiontitle">Response Header</h4><p id="drs_01_0007__en-us_topic_0117388900_p15728221542">Similar to a request, a response also has a header, for example, <strong id="drs_01_0007__en-us_topic_0117388900_b928413914910">Content-Type</strong>.</p>
<p id="drs_01_0007__en-us_topic_0117388900_p18572222155417"><a href="#drs_01_0007__en-us_topic_0117388900_fig85721224549">Figure 1</a> shows the response header fields for the API used to obtain a user token is called. The <strong id="drs_01_0007__en-us_topic_0117388900_b6956118181112">x-subject-token</strong> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
<div class="fignone" id="drs_01_0007__en-us_topic_0117388900_fig85721224549"><a name="drs_01_0007__en-us_topic_0117388900_fig85721224549"></a><a name="en-us_topic_0117388900_fig85721224549"></a><span class="figcap"><b>Figure 1 </b>Header fields of the response to the request for obtaining a user token</span><br><span><img id="drs_01_0007__en-us_topic_0117388900_image857242265413" src="en-us_image_0000001112644790.gif"></span></div>
</div>
<div class="section" id="drs_01_0007__en-us_topic_0117388900_section855317397543"><h4 class="sectiontitle">Response Body</h4><p id="drs_01_0007__en-us_topic_0117388900_p18620163910547">The body of a response is often returned in structured format as specified in the <strong id="drs_01_0007__en-us_topic_0117388900_b12645205131011">Content-type</strong> header field. The response body transfers content except the response header.</p>
<p id="drs_01_0007__en-us_topic_0117388900_p96201839195416">The following is part of the response body for the API used to obtain a user token. The following shows part of the response body for the API to obtain a user token.</p>
<pre class="screen" id="drs_01_0007__en-us_topic_0117388900_screen17620103912543">{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "eu-de",
......</pre>
<p id="drs_01_0007__en-us_topic_0117388900_p16201392547">If an error occurs during API calling, the system returns an error code and message to you. The following shows the format of an error response body:</p>
<pre class="screen" id="drs_01_0007__en-us_topic_0117388900_screen13620113918541">{
"error_msg": "The format of message is error",
"error_code": "AS.0001"
}</pre>
<p id="drs_01_0007__en-us_topic_0117388900_p1362013396544">In the response body, <strong id="drs_01_0007__en-us_topic_0117388900_b47910615111">error_code</strong> is an error code, and <strong id="drs_01_0007__en-us_topic_0117388900_b1979196101114">error_msg</strong> provides information about the error.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_01_0004.html">Calling APIs</a></div>
</div>
</div>

183
docs/drs/api-ref/drs_01_0008.html Normal file
View File

File diff suppressed because it is too large Load Diff

32
docs/drs/api-ref/drs_02_0004.html Normal file
View File

@ -0,0 +1,32 @@
<a name="drs_02_0004"></a><a name="drs_02_0004"></a>
<h1 class="topictitle1">API Overview</h1>
<div id="body0000001073160101"><p id="drs_02_0004__p8060118">DRS provides REST APIs. With DRS APIs, you can use all the functions of DRS, including creating migration tasks, obtaining task details, obtaining the migration task list, and deleting migration tasks.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_02_0004__table196214223413" frame="border" border="1" rules="all"><caption><b>Table 1 </b>APIs</caption><thead align="left"><tr id="drs_02_0004__row18621122215411"><th align="left" class="cellrowborder" valign="top" width="13.969999999999999%" id="mcps1.3.2.2.4.1.1"><p id="drs_02_0004__p56212221242">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.86%" id="mcps1.3.2.2.4.1.2"><p id="drs_02_0004__p76217221947">Subtype</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="72.17%" id="mcps1.3.2.2.4.1.3"><p id="drs_02_0004__p5621202216414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_02_0004__row96221122841"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.3.2.2.4.1.1 "><p id="drs_02_0004__p56227221845">DRS APIs (v3)</p>
</td>
<td class="cellrowborder" valign="top" width="13.86%" headers="mcps1.3.2.2.4.1.2 "><p id="drs_02_0004__p86229227417">Public API management</p>
</td>
<td class="cellrowborder" valign="top" width="72.17%" headers="mcps1.3.2.2.4.1.3 "><p id="drs_02_0004__p262292212418">The APIs are used to create a task, test the connection, perform a pre-check, query task details and progress, create a comparison task, delete a task, retry a task, and stop a task.</p>
</td>
</tr>
<tr id="drs_02_0004__row662211221647"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.3.2.2.4.1.1 "><p id="drs_02_0004__p46228222417">DRS APIs (v3)</p>
</td>
<td class="cellrowborder" valign="top" width="13.86%" headers="mcps1.3.2.2.4.1.2 "><p id="drs_02_0004__p116225221047">Real-time synchronization management</p>
</td>
<td class="cellrowborder" valign="top" width="72.17%" headers="mcps1.3.2.2.4.1.3 "><p id="drs_02_0004__p1262212217417">The APIs are used to process data, perform dual-VIP switchover, and query dual-VIP switchover result.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

57
docs/drs/api-ref/drs_03_0101.html Normal file
View File

@ -0,0 +1,57 @@
<a name="drs_03_0101"></a><a name="drs_03_0101"></a>
<h1 class="topictitle1">Public API Management</h1>
<div id="body31201147145410"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="drs_03_0104.html">Creating Tasks in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0105.html">Testing Connections in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0106.html">Testing Connections in Batches (Cluster Mode)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0107.html">Modifying Tasks in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0109.html">Selecting Database Objects in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0110.html">Performing a Batch Pre-Check</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0111.html">Querying Pre-check Results in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0130.html">Setting Flow Control for Tasks</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0141.html">Obtaining Database Parameters in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0131.html">Modifying Database Parameters</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0112.html">Starting Tasks in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0132.html">Resuming or Retrying Tasks in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0133.html">Pausing Tasks in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0113.html">Stopping or Deleting Tasks in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0134.html">Changing the Passwords of the Sources and Destinations</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0135.html">Setting Definers in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0136.html">Creating a Comparison Task</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0137.html">Querying Comparison Results</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0114.html">Querying Task Progress in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0151.html">Querying Task Details in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0138.html">Querying Tasks of a Tenant</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0150.html">Querying Task Statuses in Batches</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0129.html">API</a></div>
</div>
</div>

768
docs/drs/api-ref/drs_03_0104.html Normal file
View File

File diff suppressed because it is too large Load Diff

456
docs/drs/api-ref/drs_03_0105.html Normal file
View File

File diff suppressed because it is too large Load Diff

393
docs/drs/api-ref/drs_03_0106.html Normal file
View File

File diff suppressed because it is too large Load Diff

816
docs/drs/api-ref/drs_03_0107.html Normal file
View File

File diff suppressed because it is too large Load Diff

383
docs/drs/api-ref/drs_03_0109.html Normal file
View File

File diff suppressed because it is too large Load Diff

260
docs/drs/api-ref/drs_03_0110.html Normal file
View File

File diff suppressed because it is too large Load Diff

642
docs/drs/api-ref/drs_03_0111.html Normal file
View File

File diff suppressed because it is too large Load Diff

250
docs/drs/api-ref/drs_03_0112.html Normal file
View File

File diff suppressed because it is too large Load Diff

276
docs/drs/api-ref/drs_03_0113.html Normal file
View File

File diff suppressed because it is too large Load Diff

323
docs/drs/api-ref/drs_03_0114.html Normal file
View File

File diff suppressed because it is too large Load Diff

15
docs/drs/api-ref/drs_03_0121.html Normal file
View File

@ -0,0 +1,15 @@
<a name="drs_03_0121"></a><a name="drs_03_0121"></a>
<h1 class="topictitle1">Application Examples</h1>
<div id="body0000001073080424"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="drs_03_0122.html">Scenario 1: Querying Task Statuses in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0123.html">Scenario 2: Querying Task Details in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0124.html">Scenario 3: Starting Tasks in Batches</a></strong><br>
</li>
</ul>
</div>

34
docs/drs/api-ref/drs_03_0122.html Normal file
View File

@ -0,0 +1,34 @@
<a name="drs_03_0122"></a><a name="drs_03_0122"></a>
<h1 class="topictitle1">Scenario 1: Querying Task Statuses in Batches</h1>
<div id="body0000001073080816"><div class="section" id="drs_03_0122__section1594274162812"><h4 class="sectiontitle">Scenarios</h4><p id="drs_03_0122__p1494394116281">This section describes how to query the status of all tasks of a tenant by calling the API described in <a href="drs_api_0150.html">Querying Task Statuses in Batches</a>.</p>
</div>
<div class="section" id="drs_03_0122__section1728115871716"><h4 class="sectiontitle">Procedure</h4><ol id="drs_03_0122__ol160124915146"><li id="drs_03_0122__li170174911416"><span>Obtain the ID of the task to be queried by referring to <a href="drs_api_0115.html">Obtaining a Task ID</a>.</span></li><li id="drs_03_0122__li26531229161513"><span>URI format: /v3/{project_id}/jobs/batch-status</span><p><ul id="drs_03_0122__ul19341311122215"><li id="drs_03_0122__li18645111452219">Example request:<p id="drs_03_0122__p0381161420156"><a name="drs_03_0122__li18645111452219"></a><a name="li18645111452219"></a>POST: https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-status</p>
<p id="drs_03_0122__p17381414151511">Obtain the endpoint from Regions and Endpoints.</p>
</li><li id="drs_03_0122__li76700843519">Request example:<pre class="codeblock" id="drs_03_0122__codeblock6203120143910">{
"jobs": ["9a470239-2308-4bb5-a6bc-1040402fjb21", "dc67695a-ee3e-49b8-a022-a099bd81jb21"],
"pageReq": {
"cur_page": 1,
"per_page": 10
}
}</pre>
</li><li id="drs_03_0122__li20127933361">Example Response:<pre class="codeblock" id="drs_03_0122__codeblock129605623919">{
"results": [{
"id": "9a470239-2308-4bb5-a6bc-1040402fjb21",
"status": "INCRE_TRANSFER_STARTED"
}, {
"id": "dc67695a-ee3e-49b8-a022-a099bd81jb21",
"status": "INCRE_TRANSFER_FAILED"
}],
"count": 2
}</pre>
</li></ul>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0121.html">Application Examples</a></div>
</div>
</div>

139
docs/drs/api-ref/drs_03_0123.html Normal file
View File

File diff suppressed because it is too large Load Diff

29
docs/drs/api-ref/drs_03_0124.html Normal file
View File

@ -0,0 +1,29 @@
<a name="drs_03_0124"></a><a name="drs_03_0124"></a>
<h1 class="topictitle1">Scenario 3: Starting Tasks in Batches</h1>
<div id="body0000001073240726"><div class="section" id="drs_03_0124__section1594274162812"><h4 class="sectiontitle">Scenarios</h4><p id="drs_03_0124__p1494394116281">This section describes how to <a href="drs_03_0112.html">start multiple configuration tasks</a> by calling an API.</p>
</div>
<div class="section" id="drs_03_0124__section1728115871716"><h4 class="sectiontitle">Procedure</h4><ol id="drs_03_0124__ol756295284119"><li id="drs_03_0124__li14562165244114"><span>Obtain the ID of the task to be queried by referring to <a href="drs_api_0115.html">Obtaining a Task ID</a>.</span></li><li id="drs_03_0124__li188611358124110"><span>URI format: /v3/{project_id}/jobs/batch-starting</span><p><ul id="drs_03_0124__ul19341311122215"><li id="drs_03_0124__li18645111452219">Example request:<p id="drs_03_0124__p790018253212"><a name="drs_03_0124__li18645111452219"></a><a name="li18645111452219"></a>POST: https://{endpoint}/ /v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-starting</p>
<p id="drs_03_0124__p1690062572115">Obtain the endpoint from Regions and Endpoints.</p>
</li><li id="drs_03_0124__li872617173227">Request example:<pre class="codeblock" id="drs_03_0124__codeblock17330112317298">{
"jobs": [{
"job_id": "140b5236-88ad-43c8-811c-1268453jb101"
}]
}</pre>
</li><li id="drs_03_0124__li205203834314">Example Response:<pre class="codeblock" id="drs_03_0124__codeblock23054423014">{
"count": 1,
"results": [{
"id": "140b5236-88ad-43c8-811c-1268453jb101",
"status": "success"
}]
}</pre>
</li></ul>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0121.html">Application Examples</a></div>
</div>
</div>

28
docs/drs/api-ref/drs_03_0125.html Normal file
View File

@ -0,0 +1,28 @@
<a name="drs_03_0125"></a><a name="drs_03_0125"></a>
<h1 class="topictitle1">Appendix</h1>
<div id="body0000001073280325"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="drs_05_0002.html">Abnormal Request Results</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_05_0003.html">HTTP Status Codes for General Requests</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_05_0004.html">Error Code</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_05_0005.html">Task Statuses</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0106.html">Obtaining a Project ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0107.html">Obtaining an Account ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0115.html">Obtaining a Task ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0108.html">Status Code</a></strong><br>
</li>
</ul>
</div>

13
docs/drs/api-ref/drs_03_0126.html Normal file
View File

@ -0,0 +1,13 @@
<a name="drs_03_0126"></a><a name="drs_03_0126"></a>
<h1 class="topictitle1">Getting Started</h1>
<div id="body0000001073718222"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="drs_03_0127.html">Task Creation Process</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0128.html">Task Creation Example</a></strong><br>
</li>
</ul>
</div>

19
docs/drs/api-ref/drs_03_0127.html Normal file
View File

@ -0,0 +1,19 @@
<a name="drs_03_0127"></a><a name="drs_03_0127"></a>
<h1 class="topictitle1">Task Creation Process</h1>
<div id="body0000001073083528"><div class="section" id="drs_03_0127__section93333710323"><h4 class="sectiontitle">Process of Creating a Migration Task</h4><div class="fignone" id="drs_03_0127__fig134091331590"><span class="figcap"><b>Figure 1 </b>Process of creating a real-time migration task</span><br><span><img id="drs_03_0127__image94091231691" src="en-us_image_0000001383501280.png"></span></div>
<ul id="drs_03_0127__ul7638161095711"><li id="drs_03_0127__li263861085712">Call an IAM API to obtain a user token by referring to <a href="https://docs.otc.t-systems.com/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</li><li id="drs_03_0127__li1163819107576"><a href="drs_03_0104.html">Creating Tasks in Batches</a></li><li id="drs_03_0127__li136381510135712"><a href="drs_api_0150.html">Querying Task Statuses in Batches</a></li><li id="drs_03_0127__li18504142115532"><a href="drs_03_0105.html">Testing Connections in Batches</a></li><li id="drs_03_0127__li1363811085718"><a href="drs_03_0107.html">Modifying Tasks in Batches</a> </li><li id="drs_03_0127__li18131161144913"><a href="drs_03_0107.html">Add information about the database tables to be migrated.</a></li><li id="drs_03_0127__li1763881095717"><a href="drs_03_0110.html">Performing a Batch Pre-Check</a></li><li id="drs_03_0127__li15639101035720"><a href="drs_03_0141.html">Obtaining Database Parameters in Batches</a></li><li id="drs_03_0127__li3639910155718"><a href="drs_03_0112.html">Starting Tasks in Batches</a></li></ul>
</div>
<div class="section" id="drs_03_0127__section73591220105910"><h4 class="sectiontitle">Process of Creating a Real-Time Synchronization Task</h4><div class="fignone" id="drs_03_0127__fig898683842520"><span class="figcap"><b>Figure 2 </b>Process of creating a real-time synchronization task</span><br><span><img id="drs_03_0127__image169874385254" src="en-us_image_0000001383661004.png"></span></div>
<ul id="drs_03_0127__ul122515425913"><li id="drs_03_0127__li1525754105912">Call an IAM API to obtain a user token by referring to <a href="https://docs.otc.t-systems.com/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</li><li id="drs_03_0127__li325135445913"><a href="drs_03_0104.html">Creating Tasks in Batches</a></li><li id="drs_03_0127__li37612040191420"><a href="drs_api_0150.html">Querying Task Statuses in Batches</a></li><li id="drs_03_0127__li3449205785514"><a href="drs_03_0105.html">Testing Connections in Batches</a></li><li id="drs_03_0127__li12251354155919"><a href="drs_03_0107.html">Modifying Tasks in Batches</a></li><li id="drs_03_0127__li15328839105415"><a href="drs_03_0149.html">Configuring Synchronization Policies in Batches</a></li><li id="drs_03_0127__li92595410596"><a href="drs_03_0109.html">Selecting Database Objects in Batches</a></li><li id="drs_03_0127__li794895017718"><a href="drs_api_0103.html">Processing Data in Batches</a></li><li id="drs_03_0127__li17252548599"><a href="drs_03_0110.html">Performing a Batch Pre-Check</a></li><li id="drs_03_0127__li1325175425920"><a href="drs_03_0112.html">Starting Tasks in Batches</a></li></ul>
</div>
<div class="section" id="drs_03_0127__section05174453915"><h4 class="sectiontitle">Process of Creating a Real-Time DR Task</h4><div class="fignone" id="drs_03_0127__fig113171138122714"><span class="figcap"><b>Figure 3 </b>Process of creating a real-time DR task</span><br><span><img id="drs_03_0127__image1131815385279" src="en-us_image_0000001433821157.png"></span></div>
<ul id="drs_03_0127__ul16659155619146"><li id="drs_03_0127__li1765918566146">Call an IAM API to obtain a user token by referring to <a href="https://docs.otc.t-systems.com/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</li><li id="drs_03_0127__li106591956161417"><a href="drs_03_0104.html">Creating Tasks in Batches</a></li><li id="drs_03_0127__li8659125631415"><a href="drs_api_0150.html">Querying Task Statuses in Batches</a></li><li id="drs_03_0127__li7655169205610"><a href="drs_03_0105.html">Testing Connections in Batches</a></li><li id="drs_03_0127__li8660856121414"><a href="drs_03_0107.html">Modifying Tasks in Batches</a></li><li id="drs_03_0127__li1066095610148"><a href="drs_03_0130.html">Setting Flow Control for Tasks</a></li><li id="drs_03_0127__li15660135616146"><a href="drs_03_0110.html">Performing a Batch Pre-Check</a></li><li id="drs_03_0127__li921610051715"><a href="drs_03_0141.html">Obtaining Database Parameters in Batches</a></li><li id="drs_03_0127__li1566019569143"><a href="drs_03_0112.html">Starting Tasks in Batches</a></li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0126.html">Getting Started</a></div>
</div>
</div>

40
docs/drs/api-ref/drs_03_0128.html Normal file
View File

@ -0,0 +1,40 @@
<a name="drs_03_0128"></a><a name="drs_03_0128"></a>
<h1 class="topictitle1">Task Creation Example</h1>
<div id="body0000001073721330"><p id="drs_03_0128__en-us_topic_0172725484_en-us_topic_0121682346_p51148444524">This section describes how to create a real-time migration task by calling an API.</p>
<div class="section" id="drs_03_0128__en-us_topic_0172725484_en-us_topic_0121682346_section872994"><h4 class="sectiontitle">Involved APIs</h4><ul id="drs_03_0128__en-us_topic_0172725484_en-us_topic_0121682346_ul15147458"><li id="drs_03_0128__en-us_topic_0172725484_en-us_topic_0121682346_li2109397">API for obtaining tokens from IAM<p id="drs_03_0128__en-us_topic_0172725484_p1334211344337"><a name="drs_03_0128__en-us_topic_0172725484_en-us_topic_0121682346_li2109397"></a><a name="en-us_topic_0172725484_en-us_topic_0121682346_li2109397"></a>Obtain a token and add <strong id="drs_03_0128__b15642145419441">X-Auth-Token</strong> to the request header of API calls.</p>
</li><li id="drs_03_0128__en-us_topic_0172725484_li3491165213428">API used to create a real-time migration task.</li></ul>
</div>
<div class="section" id="drs_03_0128__section1934815117166"><h4 class="sectiontitle">Procedure</h4><ol id="drs_03_0128__en-us_topic_0172725484_ol3860183022920"><li id="drs_03_0128__en-us_topic_0172725484_li1286119305290"><span>Obtain the token by referring to <a href="drs_01_0005.html">Authentication</a>.</span></li><li id="drs_03_0128__en-us_topic_0172725484_li19821162010414"><span>Obtain the DRS endpoints.</span><p><ul id="drs_03_0128__en-us_topic_0172725484_ul1359819231122"><li id="drs_03_0128__en-us_topic_0172725484_li165991323621">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</p></li><li id="drs_03_0128__en-us_topic_0172725484_li149641811871"><span>Obtain the project ID of a user in a region. For details, see <a href="drs_api_0106.html">Obtaining a Project ID</a>.</span></li><li id="drs_03_0128__en-us_topic_0172725484_li8417115310290"><span>Send POST https://{<em id="drs_03_0128__i29961039105011">DRS endpoint</em>}/v3/{projectId}/jobs.</span></li><li id="drs_03_0128__en-us_topic_0172725484_li41146117301"><span>Add <strong id="drs_03_0128__b1928175085011">X-Auth-Token</strong> to the request header. The value is user token.</span></li><li id="drs_03_0128__en-us_topic_0172725484_li1319919783019"><span>Add the <strong id="drs_03_0128__b478712557503">Content-Type</strong> key to the request header. The value of <strong id="drs_03_0128__b27891755195010">Content-Type</strong> is <strong id="drs_03_0128__b6790855135014">application/json</strong>.</span></li><li class="msonormal" id="drs_03_0128__en-us_topic_0172725484_en-us_topic_0121682346_li1586314581311"><span>Specify the following parameters in the request body:</span><p><div class="note" id="drs_03_0128__en-us_topic_0172725484_note997910579171"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="drs_03_0128__en-us_topic_0172725484_p241111213123">For details about the API used for creating DB instances, see <a href="drs_03_0104.html">Creating Tasks in Batches</a>.</p>
</div></div>
<pre class="screen" id="drs_03_0128__screen110314512383">{
"bind_eip": true,//Check whether an EIP has been bound to the replication instance in the public network scenario.
"db_use_type": "migration",//The usage type. The value can be migration (real-time migration), sync (real-time synchronization), or cloudDataGuard (real-time DR). This parameter is mandatory.
""description": "",//Task description
"engine_type": "mysql",//The engine type. The value can be mysql, mongodb, or cloudDataGuard-mysql.
"is_target_readonly": true,//Specifies whether the destination instance is readable only.
"job_direction": "up",//Task direction. The value can be <strong id="drs_03_0128__b191649013522">up</strong> or <strong id="drs_03_0128__b21661107526">down</strong>.
"name": "DRS-2057",//Task name. This parameter is mandatory.
"net_type": "eip",// Network type. This parameter is mandatory and the value can be <strong id="drs_03_0128__b10843151145217">vpn</strong>, <strong id="drs_03_0128__b14844711115220">vpc</strong>, or <strong id="drs_03_0128__b20846101115218">eip</strong>.
"node_type": "high",//Specification type. This parameter is mandatory.
"source_Endpoint": {//Information body of the source database. This parameter is mandatory.
"db_type": "mysql",//The database type. The value can be mysql, mongodb, or gaussdbv5. This parameter is mandatory.
},
"target_Endpoint": {//Information body of the destination database
"db_type": "mysql",//Database type. This parameter is mandatory.
"inst_id": "63e0699063494a8a93798f38abf3247ein01",// RDS instance ID. This parameter is mandatory when the database is an RDS DB instance.
"region": "eu-de" // The region where the RDS DB instance is located. This parameter is mandatory when the database is an RDS DB instance.
},
"task_type": "FULL_INCR_TRANS" //Task mode. The value can be <strong id="drs_03_0128__b55875288521">FULL_TRANS</strong> or <strong id="drs_03_0128__b13589182819526">FULL_INCR_TRANS</strong>.
}</pre>
<p id="drs_03_0128__en-us_topic_0172725484_p137584018285">If the request fails, an error code and error information are returned. For details, see section <a href="drs_05_0004.html">Error Code</a>.</p>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0126.html">Getting Started</a></div>
</div>
</div>

16
docs/drs/api-ref/drs_03_0129.html Normal file
View File

@ -0,0 +1,16 @@
<a name="drs_03_0129"></a><a name="drs_03_0129"></a>
<h1 class="topictitle1">API</h1>
<div id="body0000001073556920"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="drs_03_0101.html">Public API Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_api_0100.html">Real-Time Synchronization Management</a></strong><br>
</li>
</ul>
</div>

306
docs/drs/api-ref/drs_03_0130.html Normal file
View File

File diff suppressed because it is too large Load Diff

245
docs/drs/api-ref/drs_03_0131.html Normal file
View File

File diff suppressed because it is too large Load Diff

247
docs/drs/api-ref/drs_03_0132.html Normal file
View File

File diff suppressed because it is too large Load Diff

252
docs/drs/api-ref/drs_03_0133.html Normal file
View File

File diff suppressed because it is too large Load Diff

338
docs/drs/api-ref/drs_03_0134.html Normal file
View File

File diff suppressed because it is too large Load Diff

252
docs/drs/api-ref/drs_03_0135.html Normal file
View File

File diff suppressed because it is too large Load Diff

442
docs/drs/api-ref/drs_03_0136.html Normal file
View File

File diff suppressed because it is too large Load Diff

1123
docs/drs/api-ref/drs_03_0137.html Normal file
View File

File diff suppressed because it is too large Load Diff

570
docs/drs/api-ref/drs_03_0138.html Normal file
View File

File diff suppressed because it is too large Load Diff

468
docs/drs/api-ref/drs_03_0141.html Normal file
View File

File diff suppressed because it is too large Load Diff

197
docs/drs/api-ref/drs_03_0147.html Normal file
View File

File diff suppressed because it is too large Load Diff

170
docs/drs/api-ref/drs_03_0148.html Normal file
View File

File diff suppressed because it is too large Load Diff

294
docs/drs/api-ref/drs_03_0149.html Normal file
View File

File diff suppressed because it is too large Load Diff

46
docs/drs/api-ref/drs_05_0002.html Normal file
View File

@ -0,0 +1,46 @@
<a name="drs_05_0002"></a><a name="drs_05_0002"></a>
<h1 class="topictitle1">Abnormal Request Results</h1>
<div id="body0000001073390295"><ul id="drs_05_0002__en-us_topic_0172725496_ul35925995"><li id="drs_05_0002__en-us_topic_0172725496_li7731587">Abnormal response description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_05_0002__en-us_topic_0172725496_table24324511" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Abnormal response description</caption><thead align="left"><tr id="drs_05_0002__en-us_topic_0172725496_row8210712"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.1.1.1.2.4.1.1"><p id="drs_05_0002__en-us_topic_0172725496_p61087939"><strong id="drs_05_0002__en-us_topic_0172725496_b108251743193414">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.1.1.1.2.4.1.2"><p id="drs_05_0002__en-us_topic_0172725496_p49176002"><strong id="drs_05_0002__en-us_topic_0172725496_b18252432343">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.1.1.1.2.4.1.3"><p id="drs_05_0002__en-us_topic_0172725496_p23833214"><strong id="drs_05_0002__en-us_topic_0172725496_b58251543143416">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="drs_05_0002__en-us_topic_0172725496_row51442142"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.1.1.1.2.4.1.1 "><p id="drs_05_0002__en-us_topic_0172725496_p6063946">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.1.1.1.2.4.1.2 "><p id="drs_05_0002__en-us_topic_0172725496_p21417643">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.1.1.1.2.4.1.3 "><p id="drs_05_0002__en-us_topic_0172725496_p57107561">Specifies the error code returned when the API response is abnormal. For details, see section <a href="drs_05_0004.html">Error Code</a>.</p>
</td>
</tr>
<tr id="drs_05_0002__en-us_topic_0172725496_row62309739"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.1.1.1.2.4.1.1 "><p id="drs_05_0002__en-us_topic_0172725496_p13924122">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.1.1.1.2.4.1.2 "><p id="drs_05_0002__en-us_topic_0172725496_p54112093">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.1.1.1.2.4.1.3 "><p id="drs_05_0002__en-us_topic_0172725496_p21003421">Specifies the description of the error returned when the API response is abnormal.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="drs_05_0002__en-us_topic_0172725496_ul17594011"><li id="drs_05_0002__en-us_topic_0172725496_li54813063">Example Response:<pre class="codeblock" id="drs_05_0002__en-us_topic_0172725496_codeblock7477111014372">{
"error_code": "DRS.M00201",
"error_msg": "The %s parameter is empty."
}
{
"error_code": "DRS.M00202",
"error_msg": "The value of %s is invalid."
}</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0125.html">Appendix</a></div>
</div>
</div>

102
docs/drs/api-ref/drs_05_0003.html Normal file
View File

File diff suppressed because it is too large Load Diff

337
docs/drs/api-ref/drs_05_0004.html Normal file
View File

File diff suppressed because it is too large Load Diff

135
docs/drs/api-ref/drs_05_0005.html Normal file
View File

File diff suppressed because it is too large Load Diff

21
docs/drs/api-ref/drs_api_0100.html Normal file
View File

@ -0,0 +1,21 @@
<a name="drs_api_0100"></a><a name="drs_api_0100"></a>
<h1 class="topictitle1">Real-Time Synchronization Management</h1>
<div id="body3291161607"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="drs_api_0103.html">Processing Data in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0147.html">Performing a Switchover</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0148.html">Querying the Switchover Result</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="drs_03_0149.html">Configuring Synchronization Policies in Batches</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0129.html">API</a></div>
</div>
</div>

448
docs/drs/api-ref/drs_api_0103.html Normal file
View File

File diff suppressed because it is too large Load Diff

41
docs/drs/api-ref/drs_api_0106.html Normal file
View File

@ -0,0 +1,41 @@
<a name="drs_api_0106"></a><a name="drs_api_0106"></a>
<h1 class="topictitle1">Obtaining a Project ID</h1>
<div id="body0000001073078471"><div class="section" id="drs_api_0106__en-us_topic_0172726780_section3682103592310"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="drs_api_0106__en-us_topic_0172726780_p319120186281">A project ID needs to be specified in the URLs of some APIs. Therefore, you need to obtain a project ID before calling such APIs. To do so, perform the following operations:</p>
<ol id="drs_api_0106__en-us_topic_0172726780_ol1449901513354"><li id="drs_api_0106__en-us_topic_0172726780_li17914130122814"><span>Sign up and log in to the management console.</span></li><li id="drs_api_0106__en-us_topic_0172726780_li11993234162815"><span>Click the username and choose <strong id="drs_api_0106__b14428155302515">My Credentials</strong> from the drop-down list.</span></li><li id="drs_api_0106__en-us_topic_0172726780_li27151325193517"><span>On the <strong id="drs_api_0106__b12805103682718">API Credentials</strong> page, view the project ID in the project list.</span><p><p id="drs_api_0106__en-us_topic_0172726780_p183567556271">If there are multiple projects in one region, expand <strong id="drs_api_0106__en-us_topic_0172726780_b851982115342">Region</strong> and view subproject IDs in the <strong id="drs_api_0106__en-us_topic_0172726780_b18520102113344">Project ID</strong> column.</p>
</p></li></ol>
</div>
<div class="section" id="drs_api_0106__en-us_topic_0172726780_section11269315243"><h4 class="sectiontitle">Obtaining the Project ID by Calling an API</h4><p id="drs_api_0106__en-us_topic_0172726780_p1033710172412">You can also obtain the project ID by calling the API used to query project information based on the specified criteria.</p>
<p id="drs_api_0106__en-us_topic_0172726780_p1933716122415">The API used to obtain a project ID is <strong id="drs_api_0106__en-us_topic_0172726780_b12649275357">GET https://</strong><em id="drs_api_0106__en-us_topic_0172726780_i165119712359">{Endpoint}</em><strong id="drs_api_0106__en-us_topic_0172726780_b13652177153510">/v3/projects/</strong>, where <em id="drs_api_0106__en-us_topic_0172726780_i1765457103513">{Endpoint}</em> indicates the IAM endpoint. You can obtain the IAM endpoint from <a href="https://docs.otc.t-systems.com/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. For details about API authentication, see <a href="drs_01_0005.html">Authentication</a>.</p>
<p id="drs_api_0106__en-us_topic_0172726780_p1233731132413">The following is an example response. The value of <strong id="drs_api_0106__en-us_topic_0172726780_b14547259123514">id</strong> is the project ID.</p>
<pre class="screen" id="drs_api_0106__en-us_topic_0172726780_screen173375162419">{
"projects": [
{
"domain_id": "65382450e8f64ac0870cd180d14e684b",
"is_domain": false,
"parent_id": "65382450e8f64ac0870cd180d14e684b",
"name": "eu-de",
"description": "",
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
},
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
"enabled": true
}
],
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects"
}
}</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0125.html">Appendix</a></div>
</div>
</div>

Some files were not shown because too many files have changed in this diff Show More