华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 域名的描述信息。长度不超过255个字符。 email 否 String 管理该zone的管理员邮箱。 如果为空,表示维持原值。 默认值为空。 ttl 否 Integer 用于填写默认生成的SOA记录中有效缓存时间,以秒为单位。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 nameservers Array of nameserver objects 查询单个公网Zone的名称服务器响应。 表4 nameserver 参数 参数类型 描述 hostname String 主机名。 priority Integer 优先级。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 404 表6 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 version VersionItem object 待查询版本号。以v开头,如v2。 表3 VersionItem 参数 参数类型 描述 id String 版本ID(版本号),如v2。 status String 版本状态,为如下3种: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 links Array of LinksItem objects API的URL地址。 updated String 版本发布时间。 version String 支持的最大微版本号。若该版本API不支持微版本,则为空。 min_version String 支持的最小微版本号。若该版本API不支持微版本,则为空。 表4 LinksItem 参数 参数类型 描述 href String 对应快捷链接。 rel String 快捷链接标记名称。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 404 表6 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 API对象信息。 { "version" : { "status" : "CURRENT", "id" : "v2", "links" : [ { "href" : "https://Endpoint/v2/", "rel" : "self" } ], "min_version" : "", "updated" : "2018-09-18T00:00:00Z", "version" : "" } }
  • 响应示例 状态码: 200 查询单个Record Set响应。 { "id" : "2c9eb155587228570158722b6ac30007", "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 300, "records" : [ "192.168.10.2", "192.168.10.1" ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "created_at" : "2016-11-17T12:03:17.827", "updated_at" : "2016-11-17T12:56:03.827", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null, "bundle" : "free" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String Record Set的ID。 name String Record Set的名称。 description String Record Set的描述信息。 zone_id String 托管该记录的zone_id。 zone_name String 托管该记录的zone_name。 type String 记录类型。 ttl Integer 解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 records Array of strings 域名解析后的值。 created_at String 创建时间。 updated_at String 更新时间。 status String 资源状态。 default Boolean 标识是否由系统默认生成,系统默认生成的Record Set不能删除。 project_id String 该Record Set所属的项目ID。 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 line String 解析线路ID。 weight Integer 解析记录的权重。 health_check_id String 健康检查ID。 alias_target alias_target object 别名记录。 bundle String 规格,默认规格,保留字段。 表4 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。 表5 alias_target 参数 参数类型 描述 resource_type String 资源服务类型,支持别名记录的服务。取值: cloudsite:云速建站 waf: Web应用防火墙 resource_domain_name String 对应服务下的域名,由各服务提供。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 nameservers Array of PrivateNameServer objects 名称服务器列表信息。 表4 PrivateNameServer 参数 参数类型 描述 priority Integer 优先级。如果priority的值为“1”,表示会第一个采用该域名服务器进行解析。 address String DNS服务器地址。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 404 表6 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 查询单个Zone下Record Set列表响应。 { "links" : { "self" : "https://Endpoint/v2/recordsets?limit=10&marker=&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149", "next" : "https://Endpoint/v2/recordsets?limit=10&marker=2c9eb155587194ec01587224c9f9014a&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149" }, "recordsets" : [ { "id" : "2c9eb155587194ec01587224c9f9014a", "name" : "example.com.", "type" : "SOA", "ttl" : 300, "records" : [ "ns1.hotrot.de. xx.example.com. (1 7200 900 1209600 300)" ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a" }, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T11:56:03.439", "update_at" : "2016-11-17T12:56:03.827", "default" : true, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c" }, { "id" : "2c9eb155587194ec01587224c9f9014c", "name" : "example.com.", "type" : "NS", "ttl" : 172800, "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c" }, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T11:56:03.439", "update_at" : "2016-11-17T12:56:03.827", "default" : true, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c" }, { "id" : "2c9eb155587228570158722b6ac30007", "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 300, "records" : [ "192.168.10.2", "192.168.10.1" ], "status" : "PENDING_CREATE", "links" : { "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007" }, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T12:03:17.827", "update_at" : "2016-11-17T12:56:03.827", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c" } ], "metadata" : { "total_count" : 3 } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 recordsets Array of ListRecordSets objects recordset列表对象。 metadata metadata object 返回满足过滤条件的资源总数。 表5 ListRecordSets 参数 参数类型 描述 id String Record Set的ID。 name String Record Set的名称。 description String Record Set的描述信息。 zone_id String 托管该记录的zone_id。 zone_name String 托管该记录的zone_name。 type String 记录类型。 ttl Integer 解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 records Array of strings 域名解析后的值。 create_at String 创建时间。 update_at String 更新时间。 status String 资源状态。 default Boolean 标识是否由系统默认生成,系统默认生成的Record Set不能删除。 project_id String 该Record Set所属的项目ID。 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 表6 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。 表7 metadata 参数 参数类型 描述 total_count Integer 满足查询条件的资源总数,不受分页(即limit、offset参数)影响。
  • URI GET /v2/zones/{zone_id}/recordsets 表1 路径参数 参数 是否必选 参数类型 描述 zone_id 是 String 所属zone id。 最小长度:32 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 search_mode 否 String 查询条件搜索模式。 取值范围: like:模糊搜索 equal:精确搜索 marker 否 String 分页查询起始的资源ID,为空时为查询第一页。 默认值为空。 limit 否 Integer 每页返回的资源个数。 取值范围:0~500 取值一般为10,20,50。默认值为500。 offset 否 Integer 分页查询起始偏移量,表示从偏移量的下一个资源开始查询。 取值范围:0~2147483647 默认值为0。 当前设置marker不为空时,以marker为分页起始标识。 tags 否 String 资源标签。 取值格式:key1,value1|key2,value2 多个标签之间用"|"分开,每个标签的键值用英文逗号","相隔。 status 否 String 待查询的Record Set的状态。 取值范围:ACTIVE、ERROR、DISABLE、FREEZE、PENDING_CREATE、PENDING_UPDATE、PENDING_DELETE type 否 String 待查询的Record Set的记录集类型。公网域名场景的记录类型: A、AAAA、MX、CNAME、TXT、NS、SRV、CAA。内网域名场景的记录类型: A、AAAA、MX、CNAME、TXT、SRV。 name 否 String 待查询的Record Set的域名中包含此name。 搜索模式默认为模糊搜索。 默认值为空。 id 否 String 待查询的Record Set的id包含此id。 搜索模式默认为模糊搜索。 默认值为空。 sort_key 否 String 查询结果中Record Set列表的排序字段。 取值范围为: name:域名 type:记录集类型 默认值为空,表示不排序。 sort_dir 否 String 查询结果中Record Set列表的排序方式。 取值范围: desc:降序排序 asc:升序排序 默认值为空,表示不排序。
  • 响应示例 状态码: 200 查询单个Zone下Record Set列表响应。 { "links" : { "self" : "https://Endpoint/v2.1/recordsets?limit=10&marker=&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149", "next" : "https://Endpoint/v2.1/recordsets?limit=10&marker=2c9eb155587194ec01587224c9f9014a&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149" }, "recordsets" : [ { "id" : "2c9eb155587194ec01587224c9f9014a", "name" : "example.com.", "type" : "SOA", "ttl" : 300, "records" : [ "ns1.hotrot.de. xx.example.com. (1 7200 900 1209600 300)" ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T11:56:03.439", "update_at" : "2016-11-17T11:56:06.439", "default" : true, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null }, { "id" : "2c9eb155587194ec01587224c9f9014c", "name" : "example.com.", "type" : "NS", "ttl" : 172800, "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T11:56:03.439", "update_at" : "2016-11-17T11:56:06.439", "default" : true, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null }, { "id" : "2c9eb155587228570158722b6ac30007", "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 300, "records" : [ "192.168.10.2", "192.168.10.1" ], "status" : "PENDING_CREATE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T12:03:17.827", "update_at" : "2016-11-17T12:56:06.439", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null } ], "metadata" : { "total_count" : 3 } }
  • URI GET /v2.1/zones/{zone_id}/recordsets 表1 路径参数 参数 是否必选 参数类型 描述 zone_id 是 String 所属zone的ID。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询起始的资源ID,为空时为查询第一页。 默认值为空。 limit 否 Integer 每页返回的资源个数。 取值范围:0~500 取值一般为10,20,50。默认值为500。 offset 否 Integer 分页查询起始偏移量,表示从偏移量的下一个资源开始查询。 取值范围:0~2147483647 默认值为0。 当前设置marker不为空时,以marker为分页起始标识。 line_id 否 String 解析线路ID。 tags 否 String 资源标签。 取值格式:key1,value1|key2,value2 多个标签之间用"|"分开,每个标签的键值用英文逗号","相隔。 status 否 String 待查询的Record Set的状态。取值范围:ACTIVE、ERROR、DISABLE、FREEZE、PENDING_CREATE、PENDING_UPDATE、PENDING_DELETE type 否 String 待查询的Record Set的记录集类型。 公网域名场景的记录类型: A、AAAA、MX、CNAME、TXT、NS、SRV、CAA。 内网域名场景的记录类型: A、AAAA、MX、CNAME、TXT、SRV。 name 否 String 待查询的Record Set的域名中包含此name。 搜索模式默认为模糊搜索。 默认值为空。 id 否 String 待查询的Record Set的id包含此id。 搜索模式默认为模糊搜索。 默认值为空。 sort_key 否 String 查询结果中Record Set列表的排序字段。 取值范围: name:域名 type:记录集类型 默认值为空,表示不排序。 sort_dir 否 String 查询结果中Record Set列表的排序方式。 取值范围: desc:降序排序 asc:升序排序 默认值为空,表示不排序。 search_mode 否 String 查询条件搜索模式。 取值范围: like:模糊搜索 equal:精确搜索
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 recordsets Array of ShowRecordSetByZoneResp objects recordset列表。 metadata metadata object 返回满足过滤条件的资源总数。 表5 ShowRecordSetByZoneResp 参数 参数类型 描述 id String Record Set的ID。 name String Record Set的名称。 description String Record Set的描述信息。 zone_id String 托管该记录的zone_id。 zone_name String 托管该记录的zone_name。 type String 记录类型。 取值范围:A、AAAA、MX、CNAME、TXT、NS、SRV、CAA。 ttl Integer 解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 records Array of strings 域名解析后的值。 create_at String 创建时间。 update_at String 更新时间。 status String 资源状态。 default Boolean 标识是否由系统默认生成,系统默认生成的Record Set不能删除。 project_id String 该Record Set所属的项目ID。 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 line String 解析线路ID。 weight Integer 解析记录的权重。 health_check_id String 健康检查ID。 alias_target alias_target object 别名记录。 表6 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。 表7 alias_target 参数 参数类型 描述 resource_type String 资源服务类型,支持别名记录的服务。取值: cloudsite:云速建站 waf:Web应用防火墙 resource_domain_name String 对应服务下的域名,由各服务提供。 表8 metadata 参数 参数类型 描述 total_count Integer 满足查询条件的资源总数,不受分页(即limit、offset参数)影响。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 health_check_id String 健康检查ID。 通过云解析服务的管理控制台,在健康检查的详情页面中获取。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表5 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 quotas Array of quotas objects 配额项数据。 表4 quotas 参数 参数类型 描述 quota_key String 资源类型。 quota_limit Integer 资源配额的最大值。 used Integer 配额已使用数量。 unit String 配额统计单位,取固定值“count”。
  • 响应示例 状态码: 200 查询租户配额响应。 { "quotas" : [ { "quota_key" : "zone", "quota_limit" : 50, "used" : 30, "unit" : "count" }, { "quota_key" : "record_set", "quota_limit" : 500, "used" : 300, "unit" : "count" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String zone的ID,uuid形式的一个资源标识。 name String zone名称。 description String 对zone的描述信息。 email String 管理该zone的管理员邮箱。 zone_type String zone类型,内网(private)。 ttl Integer 该zone下SOA记录中的ttl值。 serial Integer 该zone下SOA记录中用于标识zone文件变更的序列值,用于主从节点同步。 status String 资源状态 record_num Integer 该zone下的recordset个数。 pool_id String 托管该zone的pool,由系统分配。 project_id String zone所属的项目ID。 created_at String 创建时间。 updated_at String 更新时间。 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 masters Array of strings 主从模式中,从DNS服务器用以获取DNS信息。 routers Array of RouterWithStatus objects 与该zone关联的Router(VPC)列表。 表4 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。 表5 RouterWithStatus 参数 参数类型 描述 status String 资源状态。 router_id String Router(VPC)所属VPC的ID。 router_region String Router(VPC)所在的region。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 404 表7 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 删除内网Zone响应。 { "id" : "ff8080825b8fc86c015b94bc6f8712c3", "name" : "example.com.", "description" : "This is an example zone.", "email" : "xx@example.com", "ttl" : 300, "serial" : 1, "masters" : [ ], "status" : "PENDING_DELETE", "links" : { "self" : "https://Endpoint/v2/zones/ff8080825b8fc86c015b94bc6f8712c3" }, "pool_id" : "ff8080825ab738f4015ab7513298010e", "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "zone_type" : "private", "created_at" : "2017-04-22T10:05:23.110", "updated_at" : "2017-04-22T10:05:23.959", "record_num" : 0, "routers" : [ { "status" : "ACTIVE", "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558", "router_region" : "xx" }, { "status" : "ACTIVE", "router_id" : "f0791650-db8c-4a20-8a44-a06c6e24b15b", "router_region" : "xx" } ] }
  • 请求示例 修改单个解析记录,设置类型为A,TTL为3600秒,解析记录值为 "192.168.10.1"、"192.168.10.2"。 PUT https://{endpoint}/v2/zones/{zone_id}/recordsets/{recordset_id} { "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 3600, "records" : [ "192.168.10.1", "192.168.10.2" ] }
  • 响应示例 状态码: 200 修改单个Record Set响应。 { "id" : "2c9eb155587228570158722b6ac30007", "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 3600, "records" : [ "192.168.10.1", "192.168.10.2" ], "status" : "PENDING_UPDATE", "links" : { "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007" }, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T12:03:17.827", "update_at" : "2016-11-17T12:56:03.827", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String Record Set的ID。 name String Record Set的名称。 description String Record Set的描述信息。 zone_id String 托管该记录的zone_id。 zone_name String 托管该记录的zone_name。 type String 记录类型。 取值范围: 公网支持修改类型:A、AAAA、MX、CNAME、TXT、NS、SRV、CAA。 内网支持修改类型:A、AAAA、MX、CNAME、TXT、SRV。 ttl Integer 解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 records Array of strings 域名解析后的值。 create_at String 创建时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS update_at String 更新时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS status String 资源状态。 default Boolean 标识是否由系统默认生成,系统默认生成的Record Set不能删除。 project_id String 该Record Set所属的项目ID。 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 表5 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 域名,后缀需以zone name结束且为FQDN(即以“.”号结束的完整主机名)。 description 否 String 可选配置,对域名的描述。 type 是 String Record Set的类型。 ttl 否 Integer 解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 records 否 Array of strings 解析记录的值。不同类型解析记录对应的值的规则不同。
  • 请求示例 设置弹性IP的PTR记录,设置TTL为300秒。 POST https://{endpoint}/v2/reverse/floatingips/{region}:{floatingip_id} { "ptrdname" : "www.example.com", "description" : "Description for this PTR record", "ttl" : 300, "tags" : [ { "key" : "key1", "value" : "value1" } ] }
  • 响应示例 状态码: 200 设置弹性IP的PTR记录响应。 { "id" : "region_id:c5504932-bf23-4171-b655-b87a6bc59334", "ptrdname" : "www.example.com.", "description" : "Description for this PTR record", "address" : "10.154.52.138", "action" : "CREATE", "ttl" : 300, "status" : "PENDING_CREATE", "links" : { "self" : "https://Endpoint/v2/reverse/floatingips/region_id:c5504932-bf23-4171-b655-b87a6bc59334" }, "enterprise_project_id" : 0 }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 id String PTR记录的ID,格式形如{region}:{floatingip_id}。 ptrdname String PTR记录对应的域名。 description String 对PTR记录的描述。 ttl Integer PTR记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 address String 弹性IP的IP地址。 status String 资源状态。 action String 对该资源的当前操作。取值范围:CREATE,UPDATE,DELETE,NONE CREATE:表示创建,UPDATE:表示更新,DELETE:表示删除,NONE:表示无操作 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 enterprise_project_id String 反向解析关联的企业项目ID,长度不超过36个字符。 表6 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 health_check_id String 健康检查ID。 通过云解析服务的管理控制台,在健康检查的详情页面中获取。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表5 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 线路分组名称。 不能与自定义线路名称、预制线路名称重复。 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 description 否 String 线路分组的描述信息。长度不超过255个字符。默认值为空。 lines 是 Array of strings 线路列表。
  • 响应示例 状态码: 202 更新线路分组响应。 { "name" : "linegroup", "lines" : [ "ST", "LA" ], "status" : "PENDING_UPDATE", "description" : "456", "line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf", "created_at" : "2019-07-29T08:41:38.096", "updated_at" : "2019-07-29T09:19:40.364" }
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 name String 线路分组名称。 lines Array of strings 线路分组包含的线路列表。 解析线路ID。 status String 资源状态。 取值范围:PENDING_CREATE,ACTIVE,PENDING_DELETE,PENDING_UPDATE,ERROR,FREEZE,DISABLE。 description String 线路分组的描述信息 line_id String 线路分组的id。 created_at String 创建时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 updated_at String 更新时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表6 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 recordsets Array of QueryRecordSetWithLineResp objects recordset的列表信息。 metadata metadata object 返回满足过滤条件的资源总数。 表6 QueryRecordSetWithLineResp 参数 参数类型 描述 id String Record Set的ID。 name String Record Set的名称。 description String Record Set的描述信息。 zone_id String 托管该记录的zone_id。 zone_name String 托管该记录的zone_name。 type String 记录类型。 ttl Integer 解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 records Array of strings 域名解析后的值。 created_at String 创建时间。 updated_at String 更新时间。 status String 资源状态。 default Boolean 标识是否由系统默认生成,系统默认生成的Record Set不能删除。 project_id String 该Record Set所属的项目ID。 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 line String 解析线路ID。 weight Integer 解析记录的权重。 health_check_id String 健康检查ID。 alias_target alias_target object 别名记录。 bundle String 规格,默认规格,保留字段。 表7 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。 表8 alias_target 参数 参数类型 描述 resource_type String 资源服务类型,支持别名记录的服务。取值: cloudsite:云速建站 waf:Web应用防火墙 resource_domain_name String 对应服务下的域名,由各服务提供。 表9 metadata 参数 参数类型 描述 total_count Integer 满足查询条件的资源总数,不受分页(即limit、offset参数)影响。
共100000条