You need to enable JavaScript to run this app.
导航
域名续费
最近更新时间:2024.06.26 13:18:24首次发布时间:2023.08.31 22:25:52

API 说明

API 名称:RenewDomain
API 域名:open.volcengineapi.com
API 描述:对指定的一个域名进行续费。该 API 会创建一个异步任务。您可以使用 GetAsyncTask 查询该任务的状态。

请求方法

POST

使用限制

节流限制:您每秒最多可以发送 20 个请求。

请求鉴权

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

公共参数

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

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

请求参数

请求参数

该 API 的请求参数的类型是请求正文参数。

请求参数

该 API 的请求参数的类型是请求正文参数。

参数名称数据类型必选参数说明示例
domainstring表示需要续费的一个域名。
example.com

period

int

表示域名需要续费的年数。您可以指定最少 1 年,最大 10 年。

该参数的默认值是 1

1

current_expired_time

int

表示域名的过期时间,格式是 Unix 时间戳。

如果该参数指定的过期时间与域名的实际过期日期不符,该 API 生成的续费任务会执行失败。

1693312998

示例

请求示例

POST https://open.volcengineapi.com?Version=2022-12-12&Action=RenewDomain
{
    "domain":"example.com",
    "period":8,
    "current_expired_time": 1693312998
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230522152902BF8AE46450333517309F",
        "Action": "RenewDomain",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    }
    "Result": {
        "task_no": "renew-6f2911508dfb12829"
    }
}

错误码

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