huawei-cloud-api-definitions-DNS 0.1.20250117

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"ListRecordSetsWithLineAndTagsResp":{"properties":{"links":{"$ref":"#/definitions/pageLink"},"metadata":{"$ref":"#/definitions/metadata"},"recordsets":{"description":"recordset列表信息。","items":{"$ref":"#/definitions/QueryRecordSetWithLineAndTagsResp"},"type":"array"}}},"QueryRecordSetWithLineAndTagsResp":{"properties":{"alias_target":{"$ref":"#/definitions/alias_target","description":"别名记录。"},"created_at":{"description":"创建时间。","type":"string"},"default":{"description":"标识是否由系统默认生成,系统默认生成的Record Set不能删除。","type":"boolean"},"description":{"description":"Record Set的描述信息。","type":"string"},"health_check_id":{"description":"健康检查ID。","type":"string"},"id":{"description":"Record Set的ID。","type":"string"},"line":{"description":"解析线路ID。","type":"string"},"links":{"$ref":"#/definitions/pageLink"},"name":{"description":"Record Set的名称。","type":"string"},"project_id":{"description":"该Record Set所属的项目ID。","type":"string"},"records":{"description":"域名解析后的值。","items":{"type":"string"},"type":"array"},"status":{"description":"资源状态。","type":"string"},"tags":{"$ref":"#/definitions/tagArray"},"ttl":{"description":"解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。","format":"int32","type":"integer"},"type":{"description":"记录类型。","type":"string"},"updated_at":{"description":"更新时间。","type":"string"},"weight":{"description":"解析记录的权重。","format":"int32","type":"integer"},"zone_id":{"description":"托管该记录的zone_id。","type":"string"},"zone_name":{"description":"托管该记录的zone_name。","type":"string"}}},"alias_target":{"description":"别名记录。","properties":{"resource_domain_name":{"description":"对应服务下的域名,由各服务提供。","type":"string"},"resource_type":{"description":"资源服务类型,支持别名记录的服务。取值:  cloudsite:云速建站 waf:Web应用防火墙","type":"string"}}},"metadata":{"description":"返回满足过滤条件的资源总数。","properties":{"total_count":{"description":"满足查询条件的资源总数,不受分页(即limit、offset参数)影响。","format":"int32","type":"integer"}}},"pageLink":{"description":"指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。","properties":{"next":{"description":"下一页资源的链接。","type":"string"},"self":{"description":"当前资源的链接。","type":"string"}}},"tag":{"properties":{"key":{"description":"键。最大长度36个unicode字符。 key不能为空。不能包含“=”,“*”,“<”,“>”,“\\”,“,”,“|”,“/”,且首尾字符不能为空格。","type":"string"},"value":{"description":"值。每个值最大长度43个unicode字符,可以为空字符串。 不能包含“=”,“*”,“<”,“>”,“\\”,“,”,“|”,“/”,且首尾字符不能为空格。","type":"string"}},"required":["key"]},"tagArray":{"description":"资源标签。","items":{"$ref":"#/definitions/tag"},"type":"array"}},"description":null,"group_id":"2ab479966f0f4e20b884fafa72e0161b","host":"dns.cn-north-4.myhuaweicloud.com","id":"93b4923de16040488b896e10e2b1fec5","info_version":"v2","method":"get","name":"ListRecordSetsWithLine","parameters":{"X-Auth-Token":{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."}},"paths":{"/v2.1/recordsets":{"get":{"description":"查询租户Record Set资源列表","operationId":"ListRecordSetsWithLine","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"description":"待查询的Record Set的域名类型。\n\n取值范围:public\n\n搜索模式默认为模糊搜索。\n\n默认值为public。","in":"query","name":"zone_type","required":false,"type":"string"},{"description":"分页查询起始的资源ID,为空时为查询第一页。\n\n默认值为空。","in":"query","name":"marker","pattern":"[0-9a-zA-Z-]{0,32}","required":false,"type":"string"},{"description":"每页返回的资源个数。\n\n取值范围:0~500\n\n取值一般为10,20,50。默认值为500。","format":"int32","in":"query","maximum":500,"minimum":0,"name":"limit","required":false,"type":"integer"},{"description":"分页查询起始偏移量,表示从偏移量的下一个资源开始查询。\n\n取值范围:0~2147483647\n\n默认值为0。\n\n当前设置marker不为空时,以marker为分页起始标识。","format":"int32","in":"query","minimum":0,"name":"offset","required":false,"type":"integer"},{"description":"zone的ID。","in":"query","name":"zone_id","pattern":"[0-9a-zA-Z-]{0,32}","required":false,"type":"string"},{"description":"解析线路ID。","in":"query","name":"line_id","required":false,"type":"string"},{"description":"资源标签。\n\n取值格式:key1,value1|key2,value2\n\n多个标签之间用\"|\"分开,每个标签的键值用英文逗号\",\"相隔。","in":"query","name":"tags","required":false,"type":"string"},{"description":"待查询的Record Set的状态。\n\n取值范围:ACTIVE、ERROR、DISABLE、FREEZE、PENDING_CREATE、PENDING_UPDATE、PENDING_DELETE","in":"query","name":"status","required":false,"type":"string"},{"description":"待查询的Record Set的记录集类型。\n\n取值范围:A、CNAME、MX、AAAA、TXT、SRV、NS、CAA","in":"query","name":"type","pattern":"|A|AAAA|MX|CNAME|TXT|NS|SRV|CAA","required":false,"type":"string"},{"description":"待查询的Record Set的域名中包含此name。\n\n搜索模式默认为模糊搜索。\n\n默认值为空。","in":"query","name":"name","required":false,"type":"string"},{"description":"待查询的Record Set的id包含此id。","in":"query","name":"id","required":false,"type":"string"},{"description":"待查询的Record Set的值中包含此records。\n\n搜索模式默认为模糊搜索。\n\n默认值为空。","in":"query","maxLength":4096,"name":"records","required":false,"type":"string"},{"description":"查询结果中Record Set列表的排序字段。\n\n取值范围:\n\nname:记录集名称\ntype:记录集类型\n默认值为空,表示不排序。","in":"query","name":"sort_key","pattern":"|name|type|view_name|created_at|updated_at","required":false,"type":"string"},{"description":"查询结果中Record Set列表的排序方式。\n\n取值范围:\n\ndesc:降序排序\nasc:升序排序\n默认值为空,表示不排序。","in":"query","name":"sort_dir","pattern":"|asc|desc","required":false,"type":"string"},{"description":"健康检查ID。\n\n搜索模式默认为模糊搜索。\n\n默认值为空。","in":"query","name":"health_check_id","required":false,"type":"string"},{"description":"查询条件搜索模式。\n\n取值范围:\n\nlike:模糊搜索\nequal:精确搜索","in":"query","name":"search_mode","pattern":"|like|equal","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"查询租户Record Set资源列表。","examples":{"application/json":{"links":{"next":"https://Endpoint/v2.1/recordsets?id=&limit=10&marker=2c9eb155587194ec01587224c9f9014a","self":"https://Endpoint/v2.1/recordsets"},"metadata":{"total_count":5},"recordsets":[{"alias_target":null,"created_at":"2016-11-17T11:56:03.439","default":true,"health_check_id":null,"id":"2c9eb155587194ec01587224c9f9014a","line":"default_view","links":{"self":"https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a"},"name":"example.com.","project_id":"e55c6f3dc4e34c9f86353b664ae0e70c","records":["ns1.hotrot.de. xx.example.com. (1 7200 900 1209600 300)"],"status":"ACTIVE","ttl":300,"type":"SOA","updated_at":"2016-11-17T11:56:06.439","weight":1,"zone_id":"2c9eb155587194ec01587224c9f90149","zone_name":"example.com."},{"alias_target":null,"created_at":"2016-11-17T11:56:03.439","default":true,"health_check_id":null,"id":"2c9eb155587194ec01587224c9f9014c","line":"default_view","links":{"self":"https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c"},"name":"example.com.","project_id":"e55c6f3dc4e34c9f86353b664ae0e70c","records":["ns2.hotrot.de.","ns1.hotrot.de."],"status":"ACTIVE","ttl":172800,"type":"NS","updated_at":"2016-11-17T11:56:06.439","weight":1,"zone_id":"2c9eb155587194ec01587224c9f90149","zone_name":"example.com."},{"alias_target":null,"created_at":"2016-11-17T12:01:17.996","default":true,"health_check_id":null,"id":"2c9eb155587228570158722996ca0002","line":"xxx","links":{"self":"https://Endpoint/v2.1/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0002"},"name":"example.org.","project_id":"e55c6f3dc4e34c9f86353b664ae0e70c","records":["ns1.hotrot.de. xx.example.org. (1 7200 900 1209600 300)"],"status":"ACTIVE","ttl":300,"type":"SOA","updated_at":"2016-11-17T12:56:06.439","weight":1,"zone_id":"2c9eb155587228570158722996c50001","zone_name":"example.org."},{"alias_target":null,"created_at":"2016-11-17T12:01:17.996","default":false,"health_check_id":null,"id":"2c9eb155587228570158722996ca0004","line":"xxx","links":{"self":"https://Endpoint/v2.1/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0004"},"name":"example.org.","project_id":"e55c6f3dc4e34c9f86353b664ae0e70c","records":["ns2.hotrot.de.","ns1.hotrot.de."],"status":"ACTIVE","ttl":172800,"type":"NS","updated_at":"2016-11-17T12:56:06.439","weight":1,"zone_id":"2c9eb155587228570158722996c50001","zone_name":"example.org."},{"alias_target":{"resource_domain_name":"2018122216193840mjysxoqn.cname.ysjianzhan.cn.","resource_type":"cloudsite"},"created_at":"2016-11-17T12:03:17.827","default":false,"description":"This is an example record set.","health_check_id":null,"id":"2c9eb155587228570158722b6ac30007","line":"default_view","links":{"self":"https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"},"name":"www.example.com.","project_id":"e55c6f3dc4e34c9f86353b664ae0e70c","records":["abc.bcd.com."],"status":"ACTIVE","ttl":300,"type":"A","updated_at":"2016-11-17T12:56:06.439","weight":1,"zone_id":"2c9eb155587194ec01587224c9f90149","zone_name":"example.com."}]}},"schema":{"$ref":"#/definitions/ListRecordSetsWithLineAndTagsResp"}}},"summary":"查询租户Record Set资源列表","tags":["Record Set多线路管理"],"x-is-registered":"Y","x-support-sdk":"Y"}}},"product_short":"DNS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询租户Record Set资源列表","tags":"Record Set多线路管理","uri":null,"version":"2.0"}