文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 实例管理/ 申请内网域名 - CreateDnsName
更新时间：2025-12-17 GMT+08:00
查看PDF
分享

申请内网域名 - CreateDnsName

功能介绍

为指定的数据库实例绑定内网域名。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:createDns

write

-

-

-

-

接口约束

该接口支持PostgreSQL、SQLServer引擎。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/create-dns

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

dns_type

是

String

参数解释：

域名类型。

约束限制：

不涉及。

取值范围：

private

默认取值：

不涉及。

请求示例

申请内网域名。 
POST https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/create-dns
{
     "dns_type": "private"
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    job_id

    String

    参数解释：

    申请内网域名的任务ID。

    取值范围：

    不涉及。
  • 正常响应要素说明 
    {
    "job_id": "b9e057a0-f0fb-4987-9d21-f3a7550b32e7"
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档