doc-exports/docs/dns/api-ref/CLASS.TXT.json
Qin Ying, Fan a79d5bdbdb DNS API 1017 version
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2022-10-20 13:26:00 +00:00

452 lines
17 KiB
JSON

[
{
"desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ",
"product_code":"dns",
"title":"API Usage Guidelines",
"uri":"dns_api_50000.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"APIs",
"uri":"dns_api_60000.html",
"doc_type":"api",
"p_code":"",
"code":"2"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Version Management",
"uri":"dns_api_61000.html",
"doc_type":"api",
"p_code":"2",
"code":"3"
},
{
"desc":"List all DNS API versions.To be interconnected with a third-party system, the current DNS version supports 1024- and 2048-bit DH key exchange algorithms, and the 2048-bit",
"product_code":"dns",
"title":"Listing All DNS API Versions",
"uri":"dns_api_61001.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"desc":"Query a specified DNS API version.To be interconnected with a third-party system, the current DNS version supports 1024- and 2048-bit DH key exchange algorithms, and the ",
"product_code":"dns",
"title":"Querying the DNS API Version",
"uri":"dns_api_61002.html",
"doc_type":"api",
"p_code":"3",
"code":"5"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Public Zone Management",
"uri":"dns_api_62000.html",
"doc_type":"api",
"p_code":"2",
"code":"6"
},
{
"desc":"Create a public zone.POST /v2/zonesParameter descriptionParameters in the requestParameterMandatoryTypeDescriptionnameYesStringDomain name registered with the domain name",
"product_code":"dns",
"title":"Creating a Public Zone",
"uri":"dns_api_62001.html",
"doc_type":"api",
"p_code":"6",
"code":"7"
},
{
"desc":"Query a public zone.GET /v2/zones/{zone_id}For details, see Table 1.Parameter in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone IDYou can obtain the value b",
"product_code":"dns",
"title":"Querying a Public Zone",
"uri":"dns_api_62002.html",
"doc_type":"api",
"p_code":"6",
"code":"8"
},
{
"desc":"Query public zones in list.GET /v2/zones?type\u003d{type}\u0026limit\u003d{limit}\u0026marker\u003d{marker}\u0026offset\u003d{offset}\u0026tags\u003d{tags}\u0026name\u003d{name}\u0026status\u003d{status}\u0026enterprise_project_id\u003d{id}For d",
"product_code":"dns",
"title":"Querying Public Zones",
"uri":"dns_api_62003.html",
"doc_type":"api",
"p_code":"6",
"code":"9"
},
{
"desc":"Query name servers in a public zone.GET /v2/zones/{zone_id}/nameserversFor details, see Table 1.Parameter in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone ",
"product_code":"dns",
"title":"Querying Name Servers in a Public Zone",
"uri":"dns_api_62004.html",
"doc_type":"api",
"p_code":"6",
"code":"10"
},
{
"desc":"Delete a public zone.DELETE /v2/zones/{zone_id}For details, see Table 1.Parameter in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone IDYou can obtain the val",
"product_code":"dns",
"title":"Deleting a Public Zone",
"uri":"dns_api_62005.html",
"doc_type":"api",
"p_code":"6",
"code":"11"
},
{
"desc":"Modify a public zone.PATCH /v2/zones/{zone_id}For details, see Table 1.Parameter in the URIParameterMandatoryTypeDescriptionzone_idYesStringID of the zone to be modifiedY",
"product_code":"dns",
"title":"Modifying a Public Zone",
"uri":"dns_api_62006.html",
"doc_type":"api",
"p_code":"6",
"code":"12"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Private Zone Management",
"uri":"dns_api_63000.html",
"doc_type":"api",
"p_code":"2",
"code":"13"
},
{
"desc":"Private zones are region-level resources, which are isolated and managed based on projects.Before creating, querying, or deleting private zones, specify a project in X-Pr",
"product_code":"dns",
"title":"Description on Private Zone APIs",
"uri":"dns_api_63001.html",
"doc_type":"api",
"p_code":"13",
"code":"14"
},
{
"desc":"Create a private zone.POST /v2/zonesParameter descriptionParameters in the requestParameterMandatoryTypeDescriptionnameYesStringDomain name of the zone to be createdIf a ",
"product_code":"dns",
"title":"Creating a Private Zone",
"uri":"dns_api_63002.html",
"doc_type":"api",
"p_code":"13",
"code":"15"
},
{
"desc":"Associate a private zone with a VPC.POST /v2/zones/{zone_id}/associaterouterFor details, see Table 1.Parameter in the URIParameterMandatoryTypeDescriptionzone_idYesString",
"product_code":"dns",
"title":"Associating a Private Zone with a VPC",
"uri":"dns_api_63003.html",
"doc_type":"api",
"p_code":"13",
"code":"16"
},
{
"desc":"Disassociate a VPC from a private zone.When a private zone is associated with only one VPC, you cannot disassociate it.POST /v2/zones/{zone_id}/disassociaterouterFor deta",
"product_code":"dns",
"title":"Disassociating a VPC from a Private Zone",
"uri":"dns_api_63004.html",
"doc_type":"api",
"p_code":"13",
"code":"17"
},
{
"desc":"Query a private zone.GET /v2/zones/{zone_id}For details, see Table 1.Parameter in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone IDYou can obtain the value ",
"product_code":"dns",
"title":"Querying a Private Zone",
"uri":"dns_api_63005.html",
"doc_type":"api",
"p_code":"13",
"code":"18"
},
{
"desc":"Query private zones in list.GET /v2/zones?type\u003d{type}\u0026limit\u003d{limit}\u0026marker\u003d{marker}\u0026offset\u003d{offset}\u0026tags\u003d{tags}\u0026name\u003d{name}\u0026status\u003d{status}\u0026enterprise_project_id\u003d{id}For ",
"product_code":"dns",
"title":"Querying Private Zones",
"uri":"dns_api_63006.html",
"doc_type":"api",
"p_code":"13",
"code":"19"
},
{
"desc":"Query name servers in a private zone.GET /v2/zones/{zone_id}/nameserversFor details, see Table 1.Parameter in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone",
"product_code":"dns",
"title":"Querying Name Servers in a Private Zone",
"uri":"dns_api_63007.html",
"doc_type":"api",
"p_code":"13",
"code":"20"
},
{
"desc":"Delete a private zone.DELETE /v2/zones/{zone_id}For details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone IDYou can obtain the v",
"product_code":"dns",
"title":"Deleting a Private Zone",
"uri":"dns_api_63008.html",
"doc_type":"api",
"p_code":"13",
"code":"21"
},
{
"desc":"Modify a private zone.PATCH /v2/zones/{zone_id}For details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionzone_idYesStringID of the zone to be modifie",
"product_code":"dns",
"title":"Modifying a Private Zone",
"uri":"dns_api_63009.html",
"doc_type":"api",
"p_code":"13",
"code":"22"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Record Set Management",
"uri":"dns_api_64000.html",
"doc_type":"api",
"p_code":"2",
"code":"23"
},
{
"desc":"Create a record set.POST /v2/zones/{zone_id}/recordsetsFor details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone IDObtain the pu",
"product_code":"dns",
"title":"Creating a Record Set",
"uri":"dns_api_64001.html",
"doc_type":"api",
"p_code":"23",
"code":"24"
},
{
"desc":"Query a record set.GET /v2/zones/{zone_id}/recordsets/{recordset_id}For details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone ID",
"product_code":"dns",
"title":"Querying a Record Set",
"uri":"dns_api_64002.html",
"doc_type":"api",
"p_code":"23",
"code":"25"
},
{
"desc":"Query record sets in list.GET /v2/recordsets?zone_type\u003d{zone_type}\u0026limit\u003d{limit}\u0026marker\u003d{marker}\u0026offset\u003d{offset}\u0026tags\u003d{tags}\u0026status\u003d{status}\u0026type\u003d{type}\u0026name\u003d{name}\u0026id\u003d{i",
"product_code":"dns",
"title":"Querying All Record Sets",
"uri":"dns_api_64003.html",
"doc_type":"api",
"p_code":"23",
"code":"26"
},
{
"desc":"Query all record sets in a specified zone.GET /v2/zones/{zone_id}/recordsets?limit\u003d{limit}\u0026offset\u003d{offset}\u0026marker\u003d{marker}\u0026tags\u003d{tags}\u0026status\u003d{status}\u0026type\u003d{type}\u0026name\u003d{n",
"product_code":"dns",
"title":"Querying Record Sets in a Zone",
"uri":"dns_api_64004.html",
"doc_type":"api",
"p_code":"23",
"code":"27"
},
{
"desc":"Delete a record set.DELETE /v2/zones/{zone_id}/recordsets/{recordset_id}For details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionzone_idYesStringZon",
"product_code":"dns",
"title":"Deleting a Record Set",
"uri":"dns_api_64005.html",
"doc_type":"api",
"p_code":"23",
"code":"28"
},
{
"desc":"Modify a record set.PUT /v2/zones/{zone_id}/recordsets/{recordset_id}For details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionzone_idYesStringZone I",
"product_code":"dns",
"title":"Modifying a Record Set",
"uri":"dns_api_64006.html",
"doc_type":"api",
"p_code":"23",
"code":"29"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"PTR Record Management",
"uri":"dns_api_66000.html",
"doc_type":"api",
"p_code":"2",
"code":"30"
},
{
"desc":"PTR records are region-level resources, which are isolated and managed based on projects.Before creating, querying, or unsetting PTR records, specify a project in X-Proje",
"product_code":"dns",
"title":"Description on PTR Record APIs",
"uri":"dns_api_66001.html",
"doc_type":"api",
"p_code":"30",
"code":"31"
},
{
"desc":"Create a PTR record for an elastic IP address (EIP).PATCH /v2/reverse/floatingips/{region}:{floatingip_id}For details, see Table 1.Parameters in the URIParameterMandatory",
"product_code":"dns",
"title":"Creating a PTR Record",
"uri":"dns_api_66002.html",
"doc_type":"api",
"p_code":"30",
"code":"32"
},
{
"desc":"Query the PTR record of an EIP.GET /v2/reverse/floatingips/{region}:{floatingip_id}For details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionregionYe",
"product_code":"dns",
"title":"Querying a PTR Record",
"uri":"dns_api_66003.html",
"doc_type":"api",
"p_code":"30",
"code":"33"
},
{
"desc":"Query PTR records of EIPs.GET /v2/reverse/floatingips?limit\u003d{limit}\u0026marker\u003d{marker}\u0026offset\u003d{offset}\u0026tags\u003d{tags}\u0026status\u003d{status}For details, see Table 1.Parameters in the ",
"product_code":"dns",
"title":"Querying All PTR Records",
"uri":"dns_api_66004.html",
"doc_type":"api",
"p_code":"30",
"code":"34"
},
{
"desc":"Unset the PTR record to the default value.PATCH /v2/reverse/floatingips/{region}:{floatingip_id}For details, see Table 1.Parameters in the URIParameterMandatoryTypeDescri",
"product_code":"dns",
"title":"Unsetting a PTR Record",
"uri":"dns_api_66005.html",
"doc_type":"api",
"p_code":"30",
"code":"35"
},
{
"desc":"Modify the PTR record for an EIP.PATCH /v2/reverse/floatingips/{region}:{floatingip_id}For details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionregi",
"product_code":"dns",
"title":"Modifying a PTR Record",
"uri":"dns_api_66006.html",
"doc_type":"api",
"p_code":"30",
"code":"36"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Tag Management",
"uri":"dns_api_67000.html",
"doc_type":"api",
"p_code":"2",
"code":"37"
},
{
"desc":"Add tags to a specified resource.You can add a maximum of 20 tags to a resource.The API is idempotent.If a to-be-created tag has the same key as an existing tag, the tag ",
"product_code":"dns",
"title":"Adding Resource Tags",
"uri":"dns_api_67001.html",
"doc_type":"api",
"p_code":"37",
"code":"38"
},
{
"desc":"Delete a resource tag.The API is idempotent.When you delete a tag that does not exist, the system reports that the tag does not exist.DELETE /v2/{project_id}/{resource_ty",
"product_code":"dns",
"title":"Deleting a Resource Tag",
"uri":"dns_api_67002.html",
"doc_type":"api",
"p_code":"37",
"code":"39"
},
{
"desc":"Add or delete tags for a specified resource in batches.You can add a maximum of 20 tags to a resource.The API is idempotent.When you are to create tags, if there are dupl",
"product_code":"dns",
"title":"Adding or Deleting Resource Tags in Batches",
"uri":"dns_api_67003.html",
"doc_type":"api",
"p_code":"37",
"code":"40"
},
{
"desc":"Query tags of a specified resource.GET /v2/{project_id}/{resource_type}/{resource_id}/tagsFor details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionp",
"product_code":"dns",
"title":"Querying Tags of a Resource",
"uri":"dns_api_67004.html",
"doc_type":"api",
"p_code":"37",
"code":"41"
},
{
"desc":"Query all tags of a resource type.GET /v2/{project_id}/{resource_type}/tagsFor details, see Table 1.Parameters in the URIParameterMandatoryTypeDescriptionproject_idYesStr",
"product_code":"dns",
"title":"Querying Tags of a Specified Resource Type",
"uri":"dns_api_67005.html",
"doc_type":"api",
"p_code":"37",
"code":"42"
},
{
"desc":"Query DNS resources by tag.Resources are sorted by creation time in descending order.POST /v2/{project_id}/{resource_type}/resource_instances/actionFor details, see Table",
"product_code":"dns",
"title":"Querying Resources by Tag",
"uri":"dns_api_67006.html",
"doc_type":"api",
"p_code":"37",
"code":"43"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Public Parameters",
"uri":"dns_api_80000.html",
"doc_type":"api",
"p_code":"",
"code":"44"
},
{
"desc":"NormalReturn code for successful requestsReturned ValueDescription200Request succeeded.202Request accepted.204No content.AbnormalReturn code for failed requestsReturned V",
"product_code":"dns",
"title":"Status Code",
"uri":"dns_api_80002.html",
"doc_type":"api",
"p_code":"44",
"code":"45"
},
{
"desc":"When an API call encounters an error, an error structure is returned. This section describes parameters of the DNS error codes.",
"product_code":"dns",
"title":"Error Code",
"uri":"dns_api_80003.html",
"doc_type":"api",
"p_code":"44",
"code":"46"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Enumeration Values",
"uri":"dns_api_80005.html",
"doc_type":"api",
"p_code":"44",
"code":"47"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Data Structure",
"uri":"dns_api_80006.html",
"doc_type":"api",
"p_code":"44",
"code":"48"
},
{
"desc":"A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to ob",
"product_code":"dns",
"title":"Obtaining a Project ID",
"uri":"dns_api_80007.html",
"doc_type":"api",
"p_code":"44",
"code":"49"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dns",
"title":"Change History",
"uri":"dns_api_a0000.html",
"doc_type":"api",
"p_code":"",
"code":"50"
}
]