You need to enable JavaScript to run this app.
导航
查询异步任务详情
最近更新时间:2023.06.25 18:12:16首次发布时间:2022.12.21 20:29:40

API 说明

API 名称:GetAsyncTask
API 域名:open.volcengineapi.com
API 描述:查询火山引擎域名服务中异步任务的执行状态。操作包括域名注册,域名续费等。

请求方法

GET

使用限制

节流限制:每秒最多提交 100 个请求。

请求鉴权

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权

公共参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称数据类型是否必选参数说明
Actionstring表示 API 的名称。该参数的取值是GetAsyncTask
Versionstring表示 API 的版本。该参数的取值是 2022-12-12

请求参数

该 API 的请求参数的类型是查询参数。

参数名称数据类型是否必选参数说明示例
task_nostring表示需要查询的异步任务的 ID。

通常,创建异步任务的 API 的响应中包含该任务 ID。例如,RegisterDomain API 的响应中包含了域名注册任务的 ID。
new-6023a78c90c878248

响应正文

参数名称数据类型参数说明示例
task_nostring表示异步任务的 ID。new-6023a78c90c878248

task_type

string

表示任务的类型。该参数有以下取值:

  • new:表示域名注册。

  • renew:表示域名续费。

  • registrant:表示域名过户。

new

resourcestring表示操作所关联的资源。例如您需要注册的域名。test.com

status

string

表示任务的执行状态。该参数有以下取值:

  • waitingExecute:表示待执行。

  • executing:表示执行中。

  • executeSuccess:表示执行成功。

  • executeFailed:表示执行失败。

  • canceled:表示执行被取消。

  • refunded:表示任务相关操作所扣除的费用已完成退款。

executeSuccess

account_idstring表示创建该任务的用户所归属的火山引擎主账号的 ID。2100080272
user_idstring表示创建该任务的用户的 ID。2100080272
annotationstring如果任务执行发生了异常,该参数会包含异常的原因。""
retry_countint该参数当前未生效。参数的取值是 00

price

string

表示任务对应的操作所产生的费用。如果该操作不产生费用,该参数值为 0。

  • 如果 task_type = new,该参数表示域名注册的费用。注册费用 = 首年价格 + 续费价格 * (注册年数 - 1)。

  • 如果 task_type = renew,该参数表示域名续费的费用。续费费用 = 续费价格 * 续费年数。

您可以使用 CheckFee 获取域名的首年价格和续费价格。

需要留意的是,如果操作所产生的费用是从域名特惠资源包中抵扣,该参数的值是 0。

80

created_atint表示任务的创建时间。格式是 Unix 时间戳。1671529245
updated_atint表示任务更新为当前状态的时间。格式是 Unix 时间戳。1671530648

请求示例

GET https://open.volcengineapi.com?Version=2022-12-12&Action=GetAsyncTask&task_no=new-6023a78c90c878248

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202212201818340102120770200576EFAA",
        "Action": "GetAsyncTask",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    },
    "Result": {
        "task_no": "new-6023a78c90c878248",
        "task_type": "new",
        "resource": "test.com",
        "status": "executeSuccess",
        "account_id": "2100089272",
        "user_id": "2100089272",
        "annotation": "",
        "retry_count": 0,
        "price": 0,
        "created_at": 1671529245,
        "updated_at": 1671530648
    }
}

错误码

如果响应正文包含 Error 字段,则表示 API 请求失败。关于更多错误码的信息,参见 错误码