华为云用户手册

  • 响应示例 状态码: 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" }
  • 请求示例 修改单个解析记录,设置类型为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 表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 解析记录的值。不同类型解析记录对应的值的规则不同。
  • 响应参数 状态码: 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 下一页资源的链接。
  • 请求示例 设置弹性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 表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
  • 响应参数 状态码: 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
  • 请求参数 表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" }
  • 响应参数 状态码: 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参数)影响。
  • 响应示例 状态码: 200 批量修改RecordSet响应。 { "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/batch/lines" }, "recordsets" : [ { "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" }, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "created_at" : "2016-11-17T12:03:17.827", "updated_at" : null, "health_check_id" : "e55c6f3dc4e34c8e86353b664ae0e89f", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 0 }, { "id" : "2c9eb155587228570158722b6ac30008", "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/2c9eb155587228570158722b6ac30008" }, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "created_at" : "2016-11-17T12:03:17.827", "updated_at" : null, "health_check_id" : "e55c6f3dc4e34c8e86353b664ae0e89c", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "Abroad", "weight" : 0 } ], "metadata" : { "total_count" : 2 } }
  • 请求示例 批量修改解析记录,设置ID"2c9eb155587194ec01587224c9f9014a"的记录集TTL为3600秒,解析记录值为"192.168.10.1"、 "192.168.10.2",权重为10;设置ID"2c9eb155587194ec01587224c9f9014c"的记录集TTL为300秒,解析记录值为"fe80:0:0:0:202:b3ff:fe1e:8329"、 "ff03:0db8:85a3:0:0:8a2e:0370:7334" ,权重为5。 PUT https://{endpoint}/v2.1/zones/{zone_id}/recordsets { "recordsets" : [ { "id" : "2c9eb155587194ec01587224c9f9014a", "description" : "This is an type A record set.", "ttl" : 3600, "weight" : 10, "records" : [ "192.168.10.1", "192.168.10.2" ] }, { "id" : "2c9eb155587194ec01587224c9f9014c", "description" : "This is an type AAAA record set.", "ttl" : 300, "weight" : 5, "records" : [ "fe80:0:0:0:202:b3ff:fe1e:8329", "ff03:0db8:85a3:0:0:8a2e:0370:7334" ] } ] }
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求,或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 响应参数 状态码: 200 表2 响应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 域名解析后的值。 create_at String 创建时间。 update_at String 更新时间。 status String 资源状态。 default Boolean 标识是否由系统默认生成,系统默认生成的Record Set不能删除。 project_id String 该Record Set所属的项目ID。 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 bundle String 规格,默认规格,保留字段。 表3 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。
  • 响应示例 状态码: 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" : "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:03:18.827", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "bundle" : "free" }
  • 请求示例 修改弹性IP的PTR记录对应的域名和描述信息,设置TTL为300秒。 PATCH https://{endpoint}/v2/reverse/floatingips/{region}:{floatingip_id} { "ptrdname" : "www.example.com", "description" : "Description for this PTR record", "ttl" : 300 }
  • 响应示例 状态码: 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" } }
  • 响应参数 状态码: 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:表示无操作 links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 表6 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。
  • 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用用户进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中的资源,使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间的资源进行分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 父主题: 使用前必读
  • 响应参数 状态码: 202 表4 响应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)信息 表5 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。 表6 RouterWithStatus 参数 参数类型 描述 status String 资源状态。 router_id String Router(VPC)所属VPC的ID。 router_region String Router(VPC)所在的region。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 404 表8 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表9 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
  • 响应示例 状态码: 202 修改内网Zone信息响应。 { "id" : "ff8080825b8fc86c015b94bc6f8712c3", "name" : "example.com.", "description" : "This is an example zone.", "email" : "xx@example.com", "ttl" : 300, "serial" : 1, "masters" : [ ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2/zones/ff8080825b8fc86c015b94bc6f8712c3" }, "pool_id" : "ff8080825ab738f4015ab7513298010e", "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "zone_type" : "private", "created_at" : "2017-04-22T08:17:08.997", "updated_at" : "2017-04-22T08:17:10.849", "record_num" : 2, "routers" : [ { "status" : "ACTIVE", "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558", "router_region" : "xx" } ] }
  • 请求参数 表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参数 参数 参数类型 描述 line_id String 解析线路ID。 name String 解析线路名称。 ip_segments Array of strings IP地址段。 created_at String 创建时间。 updated_at String 更新时间。 status String 资源状态。 description String 自定义线路的描述信息。
  • 响应示例 状态码: 200 删除单个自定义线路响应。 { "line_id" : "custom_2ce45ef669fc87870169fcbada7a0007", "name" : "customline", "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ], "status" : "PENDING_DELETE", "created_at" : "2019-04-10T12:03:17.827", "updated_at" : "2019-04-10T12:03:17.827", "description" : "123" }
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 id String zone的ID,uuid形式的一个资源标识。 name String zone名称。 description String 对zone的描述信息。 email String 管理该zone的管理员邮箱。 zone_type String zone类型,公网(public)。 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 创建时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ updated_at String 更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ links pageLink object 指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。 enterprise_project_id String 域名关联的企业项目ID,长度不超过36个字符。 masters Array of strings 主从模式中,从DNS服务器用以获取DNS信息。 目前暂未使用。 表5 pageLink 参数 参数类型 描述 self String 当前资源的链接。 next String 下一页资源的链接。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 message String 错误描述 最小长度:2 最大长度:512
共100000条