完了したドメイン名タスクの詳細 (成功したタスクや最大試行回数後にまだ失敗したタスクなど) を照会します。

AcknowledgeTaskResultを呼び出して、ドメイン名タスクの実行結果を照会できます。 ドメイン名タスクの実行結果を照会した後、PollTaskResult操作を呼び出してこのタスクを照会することはできません。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 PollTaskResult

実行したい操作。 値をPollTaskResultに設定します。

PageNum Integer 必須 1

返されるページ数。
PageSize Integer 必須 20

返される各ページのエントリ数。 最大値: 1000。

TaskResultStatus Integer 任意 2

タスクの実行結果。 設定可能な値は以下のとおりです。

  • 2: タスクが実行されます。
  • 3: タスクの実行に失敗します。
InstanceId String 任意 S20181T0WLI85212

ドメイン名のインスタンスID。

登録者プロファイルの作成後、システムは自動的にインスタンスIDを生成します。 QueryRegistrantProfilesを呼び出して、作成された登録者プロファイルのIDを照会できます。

タスク番号 String 任意 75addb07-28a3-450e-b5ec-test

タスクのID。
DomainName String 任意 example.com

ドメイン名。
Lang String 任意 en

システムがエラーメッセージを返す言語。 設定可能な値は以下のとおりです。

  • zh: 中国語
  • en: English

デフォルト値: en。

UserClientIp String 任意 127.0.0.1

クエリに使用されるクライアントのIPアドレス。 Set the value to 127.0.0.1.

レスポンスパラメーター

パラメーター データ型 例 説明
CurrentPageNum Integer 1

返されたページ数。
データ TaskDetailの配列

タスクの詳細。
TaskDetail
CreateTime String 2018-03-26 15:08:20

タスクが作成された時刻。
DomainName String example.com

ドメイン名。
ErrorMsg String 操作は正常終了しました。

タスクの実行結果を示すメッセージ。
InstanceId String S201817141000000

ドメイン名のインスタンスID。
TaskDetailNo String 15fee9d10d514bada66bd08c5723c583

タスクの詳細のID。
タスク番号 String b95bc334-f7d8-4f39-8a62-4c4302a243d8

タスクのID。
TaskResult String test

タスクの実行結果。
TaskStatus String EXECUTE_SUCCESS

タスクの実行ステータス 設定可能な値は以下のとおりです。

  • WAITING_EXECUTE: タスクは実行待ちです。
  • EXECUTING: タスクは実行中です。
  • EXECUTE_SUCCESS: タスクが実行されます。
  • EXECUTE_FAILURE: タスクの実行に失敗しました。
TaskStatusCode Integer 2

タスクのステータスコード。 設定可能な値は以下のとおりです。

  • 0: タスクは実行待ちです。
  • 1: タスクは実行中です。
  • 2: タスクが実行されます。
  • 3: タスクの実行に失敗します。
TaskType String CHG_DNS

タスクの ID を設定します。
タスクTypeDescription String DNSサーバーの変更

タスクタイプの説明。 Langパラメーターの値を変更すると、このパラメーターの値は別の言語で表示されます。
TryCount Integer 0

クエリの再試行回数。
UpdateTime String 2018-03-26 15:22:18

タスクが最後に実行された時刻。
NextPage ブール 偽

現在のページの後に別のページが続くかどうかを示します。
PageSize Integer 1

1 ページあたりで返されるエントリ数。
PrePage ブール 偽

現在のページが別のページに続くかどうかを示します。
RequestId String E879DC07-38EE-4408-9F33-73B30CD965CD

リクエストの ID です。
TotalItemNum Integer 10

返されたエントリの総数。
TotalPageNum Integer 10

返されたページの総数。

例

リクエストの例

http(s)://[Endpoint]/?Action=PollTaskResult
&PageNum=1
&PageSize=20
&<Common request parameters>

正常に処理された場合のレスポンス例

XML 形式 

<PollTaskResultResponse>
    <Data>
        <TaskDetail>
            <TryCount>0</TryCount>
            <TaskDetailNo>15fee9d10d514bada66bd08c5723c583</TaskDetailNo>
            <TaskNo>b95bc334-f7d8-4f39-8a62-4c4302a243d8</TaskNo>
            <CreateTime>2018-03-26 15:08:20</CreateTime>
            <InstanceId>S201817141000000</InstanceId>
            <UpdateTime>2018-03-26 15:22:18</UpdateTime>
            <TaskStatus>EXECUTE_SUCCESS</TaskStatus>
            <DomainNam e>example.com</DomainName>
            <TaskTypeDescription>DNSの変更 </TaskTypeDescription>
            <TaskStatusCode>2</TaskStatusCode>
            <ErrorMsg> 操作は成功です。 </ErrorMsg>
            <TaskType>CHG_DNS</TaskType>
        </TaskDetail>
    </Data>
    <TotalItemNum>10</TotalItemNum>
    <PageSize>1</PageSize>
    <CurrentPageNum>1</CurrentPageNum>
    <RequestId>C2CB6161-7971-4EB6-BC16-92A2BA3816D9</RequestId>
    <TotalPageNum>10</TotalPageNum>
</PollTaskResultResponse>

JSON 形式 

{
    "CurrentPageNum":1、
    "Data":{
        "TaskDetail":[{
            "CreateTime":"2018-03-26 15:08:20" 、
            "DomainName":"example.com" 、
            "ErrorMsg":"操作は成功しました。" 、
            "InstanceId":"S201817141000000" 、
            "TaskDetailNo":"15fee9d10d514bada66bd08c5723c583" 、
            "TaskNo":"b95bc334-f7d8-4f39-8a62-4c4302a243d8" 、
            "TaskStatus":"EXECUTE_SUCCESS" 、
            "TaskStatusCode":2、
            "TaskType":"CHG_DNS" 、
            "TaskTypeDescription":"DNS修正" 、
            "TryCount":0、
            "UpdateTime":"2018-03-26 15:22:18"
        }]
    },
    "PageSize":1,
    "RequestId":"E879DC07-38EE-4408-9F33-73B30CD965CD" 、
    "TotalItemNum":10、
    "TotalPageNum":10
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。