文档

CreateDomain - 创建域名

更新时间:

创建域名。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:CreateDomaincreate
  • 全部资源
    *

请求语法

POST /v1/domains

请求参数

名称类型必填描述示例值
bodyobject

请求 Body。

namestring

域名。

abc.com
protocolstring

域名支持的协议类型。

  • HTTP:仅支持 HTTP 协议。
  • HTTPS:仅支持 HTTPS 协议。
HTTP
forceHttpsboolean

设置 HTTPS 协议类型,是否开启强制 HTTPS 跳转。

false
certIndentifierstring

云盾证书身份。

194445-cn-hangzhou
caCertIndentifierstring

云盾 ca 证书身份。

194445-cn-hangzhou
http2Optionstring

http2 设置。

枚举值:
  • GlobalConfigGlobalConfig
  • CloseClose
  • OpenOpen
Open
tlsMaxstring

TLS 协议最大版本,最大支持 TLS 1.3。

TLS1.3
tlsMinstring

TLS 协议最小版本,最小支持 TLS 1.0。

TLS1.0

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,用于追溯 API 调用链路。

0C2D1C68-0D93-5561-8EE6-FDB7BF067A30
dataobject

响应数据。

domainIdstring

域名 id。

d-cpu1aullhtgkidg7sa4g
codestring

响应码。

Ok
messagestring

响应消息。

success

示例

正常返回示例

JSON格式

{
  "requestId": "0C2D1C68-0D93-5561-8EE6-FDB7BF067A30",
  "data": {
    "domainId": "d-cpu1aullhtgkidg7sa4g"
  },
  "code": "Ok",
  "message": "success"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-25API 内部配置变更,不影响调用查看变更详情