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 Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For DNS endpoints, see Regions and Endpoints.
+For example, call the API provided in Private Zone Management to create a private zone, and call the API provided in Record Set Management to add a record set to a private zone.
+For example, call the API provided in Public Zone Management to create a public zone, call the API provided in Record Set Management to add a record set to a public zone, and call the API provided in PTR Record Management to add a PTR record.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
+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 algorithm is recommended.
+GET /
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
versions + |
+Object + |
+Version object. For details, see Table 2. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
values + |
+Array of object + |
+Version list. For details, see Table 3. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Version status, which can be: +
|
+
id + |
+String + |
+Version number + |
+
links + |
+Array of object + |
+URL of the current version. For details, see Table 4. + |
+
{
+ "versions": {
+ "values": [
+ {
+ "status": "CURRENT",
+ "id": "v2",
+ "links": [
+ {
+ "href": "https://Endpoint/v2",
+ "rel": "self"
+ }
+ ]
+ }
+ ]
+ }
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+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 2048-bit algorithm is recommended.
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
version + |
+Object + |
+Version object. For details, see Table 3. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Version status, which can be: +
|
+
id + |
+String + |
+Version number, for example, v2 + |
+
updated + |
+String + |
+Time when the API version was released +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
version + |
+String + |
+Maximum micro-version number. If the APIs do not support micro-versions, the value is left blank. + |
+
min_version + |
+String + |
+Minimum micro-version number. If the APIs do not support micro-versions, the value is left blank. + |
+
links + |
+Array of object + |
+URL of the current version. For details, see Table 4. + |
+
{
+ "version":
+ {
+ "status": "CURRENT",
+ "id": "v2",
+ "links": [
+ {
+ "href": "https://Endpoint/v2/",
+ "rel": "self"
+ }
+ ],
+ "min_version": "",
+ "updated": "2018-09-18T00:00:00Z",
+ "version": ""
+ }
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Create a public zone.
+POST /v2/zones
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+Yes + |
+String + |
+Domain name registered with the domain name registrar +
A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters. + |
+
description + |
+No + |
+String + |
+Description of the zone, which cannot exceed 255 characters +The value is left blank by default. + |
+
zone_type + |
+No + |
+String + |
+Zone type, the value of which can be public or private +
If the value is left blank, a public zone will be created. For details about creating a private zone, see section Creating a Private Zone. + |
+
No + |
+String + |
+Email address of the administrator managing the zone +The default value is the service email address. + |
+|
ttl + |
+No + |
+Integer + |
+Caching period of the SOA record set (in seconds) +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
tags + |
+No + |
+Array of object + |
+Resource tag. For details, see Table 2. +The value is left blank by default. + |
+
enterprise_project_id + |
+No + |
+String + |
+Specifies the ID of the enterprise project associated with the public zone. The value contains a maximum of 36 characters. +The default value is 0. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Tag key. The key contains 36 Unicode characters at most and cannot be blank. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
value + |
+No + |
+String + |
+Tag value. Each value contains 43 Unicode characters at most and can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
{
+ "name": "example.com.",
+ "description": "This is an example zone.",
+ "zone_type": "public",
+ "email": "xx@example.org",
+ "ttl": 300,
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 4. + |
+
enterprise_project_id + |
+String + |
+ID of the enterprise project associated with the public zone. The value contains a maximum of 36 characters + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
{
+ "id": "2c9eb155587194ec01587224c9f90149",
+ "name": "example.com.",
+ "description": "This is an example zone.",
+ "email": "xx@example.com",
+ "ttl": 300,
+ "serial": 1,
+ "masters": [],
+ "status": "PENDING_CREATE",
+ "links": {
+ "self": "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
+ },
+ "pool_id": "00000000570e54ee01570e9939b20019",
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
+ "zone_type": "public",
+ "created_at": "2016-11-17T11:56:03.439",
+ "updated_at": null,
+ "record_num": 0
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query a public zone.
+GET /v2/zones/{zone_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +You can obtain the value by calling the API in Querying Public Zones. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 3. + |
+
enterprise_project_id + |
+String + |
+ID of the enterprise project associated with the public zone. The value contains a maximum of 36 characters. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
{
+ "id": "2c9eb155587194ec01587224c9f90149",
+ "name": "example.com.",
+ "description": "This is an example zone.",
+ "email": "xx@example.com",
+ "ttl": 300,
+ "serial": 0,
+ "masters": [],
+ "status": "ACTIVE",
+ "links": {
+ "self": "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
+ },
+ "pool_id": "00000000570e54ee01570e9939b20019",
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
+ "zone_type": "public",
+ "created_at": "2016-11-17T11:56:03.439",
+ "updated_at": "2016-11-17T11:56:05.528",
+ "record_num": 2
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query public zones in list.
+GET /v2/zones?type={type}&limit={limit}&marker={marker}&offset={offset}&tags={tags}&name={name}&status={status}&enterprise_project_id={id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
type + |
+No + |
+String + |
+Zone type, which can be public or private +
A fuzzy search will be performed. +The value is left blank by default. + |
+
marker + |
+No + |
+String + |
+Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. + |
+
limit + |
+No + |
+Integer + |
+Number of resources on each page +The value ranges from 0 to 500. +Commonly used values are 10, 20, and 50. The default value is 500. + |
+
offset + |
+No + |
+Integer + |
+Start offset of pagination query. The query will start from the next resource of the offset value. +The value ranges from 0 to 2147483647. +The default value is 0. +If marker is not left blank, the query starts from the resource specified by marker. + |
+
tags + |
+No + |
+String + |
+Resource tag +The format is as follows: key1,value1|key2,value2. +Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,). +The tags are in AND relationship. +For details, see Adding Resource Tags. +An exact match will be performed. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk. +The value is left blank by default. + |
+
name + |
+No + |
+String + |
+Zone name +A fuzzy search will be performed. + |
+
status + |
+No + |
+String + |
+Resource status +For details, see Resource Status. + |
+
enterprise_project_id + |
+No + |
+String + |
+ID of the enterprise project associated with the public zone. The value contains a maximum of 36 characters. +The default value is 0. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
zones + |
+Array of object + |
+Zone list. For details, see Table 3. + |
+
metadata + |
+Object + |
+Total number of resources that meet the filter criteria. For details, see Table 4. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
enterprise_project_id + |
+String + |
+Specifies the ID of the enterprise project associated with the public zone. The value contains a maximum of 36 characters. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
{
+ "links": {
+ "self": "https://Endpoint/v2/zones?type=public&limit=11",
+ "next": "https://Endpoint/v2/zones?type=public&limit=11&marker=2c9eb155587194ec01587224c9f90149"
+ },
+ "zones": [
+ {
+ "id": "2c9eb155587194ec01587224c9f90149",
+ "name": "example.com.",
+ "description": "This is an example zone.",
+ "email": "xx@example.com",
+ "ttl": 300,
+ "serial": 0,
+ "masters": [],
+ "status": "ACTIVE",
+ "links": {
+ "self": "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
+ },
+ "pool_id": "00000000570e54ee01570e9939b20019",
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
+ "zone_type": "public",
+ "created_at": "2016-11-17T11:56:03.439",
+ "updated_at": "2016-11-17T11:56:05.528",
+ "record_num": 2
+ },
+ {
+ "id": "2c9eb155587228570158722996c50001",
+ "name": "example.org.",
+ "description": "This is an example zone.",
+ "email": "xx@example.org",
+ "ttl": 300,
+ "serial": 0,
+ "masters": [],
+ "status": "PENDING_CREATE",
+ "links": {
+ "self": "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001"
+ },
+ "pool_id": "00000000570e54ee01570e9939b20019",
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
+ "zone_type": "public",
+ "created_at": "2016-11-17T12:01:17.996",
+ "updated_at": "2016-11-17T12:01:18.528",
+ "record_num": 2
+ }
+ ],
+ "metadata": {
+ "total_count": 2
+ }
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query name servers in a public zone.
+GET /v2/zones/{zone_id}/nameservers
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +You can obtain the value by calling the API in Querying Public Zones. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
nameservers + |
+Array of object + |
+Name server list. For details, see Table 3. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
hostname + |
+String + |
+Host name of a name server + |
+
priority + |
+Integer + |
+Priority of a name server +For example, if the priority of a name server is 1, it is used to resolve domain names in first priority. + |
+
{
+ "nameservers": [
+ {
+ "hostname": "ns1.example.com.",
+ "priority": 1
+ },
+ {
+ "hostname": "ns2.example.com.",
+ "priority": 2
+ }
+ ]
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Delete a public zone.
+DELETE /v2/zones/{zone_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +You can obtain the value by calling the API in Querying Public Zones. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 3. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
{
+ "id": "2c9eb155587194ec01587224c9f90149",
+ "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/2c9eb155587194ec01587224c9f90149"
+ },
+ "pool_id": "00000000570e54ee01570e9939b20019",
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
+ "zone_type": "public",
+ "created_at": "2016-11-17T11:56:03.439",
+ "updated_at": "2016-11-17T11:56:05.057",
+ "record_num": 0
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Modify a public zone.
+PATCH /v2/zones/{zone_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+ID of the zone to be modified +You can obtain the value by calling the API in Querying Public Zones. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
description + |
+No + |
+String + |
+Description of the zone, which cannot exceed 255 characters +If this parameter is left blank, the value will not be changed. +The value is left blank by default. + |
+
No + |
+String + |
+Email address of the administrator managing the zone +If this parameter is left blank, the value will not be changed. +The value is left blank by default. + |
+|
ttl + |
+No + |
+Integer + |
+Caching period of the SOA record set (in seconds) +The value range from 1 to 2147483647. +If this parameter is left blank, the value will not be changed. +The value is left blank by default. + |
+
Modify the zone whose ID is 2c9eb155587194ec01587224c9f90149:
+PATCH https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149
+{
+ "description": "This is an example zone.",
+ "email": "xx@example.org",
+ "ttl": 300
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 4. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
{
+ "id": "2c9eb155587194ec01587224c9f90149",
+ "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/2c9eb155587194ec01587224c9f90149"
+ },
+ "pool_id": "00000000570e54ee01570e9939b20019",
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
+ "zone_type": "public",
+ "created_at": "2016-11-17T11:56:03.439",
+ "updated_at": "2016-11-17T11:56:05.749",
+ "record_num": 2
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+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-Project-Id in the request header to perform the operations. If you do not specify one, the default project of the token will be used.
+ +Create a private zone.
+POST /v2/zones
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+Yes + |
+String + |
+Domain name of the zone to be created +
A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters. + |
+
description + |
+No + |
+String + |
+Description of the zone, which cannot exceed 255 characters +The value is left blank by default. + |
+
zone_type + |
+Yes + |
+String + |
+Zone type +The value must be private, indicating private zones accessible only to hosts in specified VPCs will be created. +For details about creating a public zone, see section Creating a Public Zone. + |
+
No + |
+String + |
+Email address of the administrator managing the zone +The default value is the service email address. + |
+|
ttl + |
+No + |
+Integer + |
+Caching period of the SOA record set (in seconds) +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
router + |
+Yes + |
+Object + |
+Router information (VPC associated with the private zone) +For details, see Table 2. + |
+
tags + |
+No + |
+Array of object + |
+Resource tag. For details, see Table 3. +The value is left blank by default. + |
+
enterprise_project_id + |
+No + |
+String + |
+Specifies the ID of the enterprise project associated with the private zone. The value contains a maximum of 36 characters. +The default value is 0. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
router_id + |
+Yes + |
+String + |
+ID of the associated VPC + |
+
router_region + |
+No + |
+String + |
+Region of the VPC +If it is left blank, the region of the project in the token takes effect by default. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Tag key. The key contains 36 Unicode characters at most and cannot be blank. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
value + |
+No + |
+String + |
+Tag value. Each value contains 43 Unicode characters at most and can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
POST https://{DNS_Endpoint}/v2/zones
+{
+ "name": "example.com.",
+ "description": "This is an example zone.",
+ "zone_type": "private",
+ "email": "xx@example.org",
+ "router": {
+ "router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
+ "router_region": "xx"
+ },
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
router + |
+Object + |
+Information about the VPC associated with the zone. For details, see Table 6. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
self + |
+String + |
+Link to the current resource + |
+
next + |
+String + |
+Link to the next page + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
router_id + |
+String + |
+Router ID (VPC ID) + |
+
router_region + |
+String + |
+Region of the VPC + |
+
{
+ "id": "ff8080825b8fc86c015b94bc6f8712c3",
+ "name": "example.com.",
+ "description": "This is an example zone.",
+ "email": "xx@example.com",
+ "ttl": 300,
+ "serial": 1,
+ "masters": [],
+ "status": "PENDING_CREATE",
+ "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": null,
+ "record_num": 0,
+ "router": {
+ "status": "PENDING_CREATE",
+ "router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
+ "router_region": "xx"
+ }
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Associate a private zone with a VPC.
+POST /v2/zones/{zone_id}/associaterouter
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +You can obtain the value by calling the API in Querying Private Zones. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
router + |
+Yes + |
+Object + |
+Router information (VPC associated with the zone) +For details, see Table 3. + |
+
POST https://{DNS_Endpoint}/v2/zones/ff8080825b8fc86c015b94bc6f8712c3/associaterouter
+{
+ "router": {
+ "router_id": "f0791650-db8c-4a20-8a44-a06c6e24b15b",
+ "router_region": "xx"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
router_id + |
+String + |
+Router ID (VPC ID) + |
+
router_region + |
+String + |
+Region of the VPC + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
{
+ "status": "PENDING_CREATE",
+ "router_id": "f0791650-db8c-4a20-8a44-a06c6e24b15b",
+ "router_region": "xx"
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+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}/disassociaterouter
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +You can obtain the value by calling the API in Querying Private Zones. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
router + |
+Yes + |
+Object + |
+Router information (VPC associated with the zone) +For details, see Table 3. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
router_id + |
+String + |
+Router ID (VPC ID) + |
+
router_region + |
+String + |
+Region of the router (VPC) + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
{
+ "status": "PENDING_DELETE",
+ "router_id": "f0791650-db8c-4a20-8a44-a06c6e24b15b",
+ "router_region": "xx"
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query a private zone.
+GET /v2/zones/{zone_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +You can obtain the value by calling the API in Querying Private Zones. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 3. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
routers + |
+Array of object + |
+Routers (VPCs associated with the zone). For details, see Table 4. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
self + |
+String + |
+Link to the current resource + |
+
next + |
+String + |
+Link to the next page + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
router_id + |
+String + |
+ID of the associated VPC + |
+
router_region + |
+String + |
+Region of the VPC +If it is left blank, the region of the project in the token takes effect by default. + |
+
{
+ "id": "ff8080825b8fc86c015b94bc6f8712c3",
+ "name": "example.com.",
+ "description": "This is an example zone.",
+ "email": "xx@example.com",
+ "ttl": 300,
+ "serial": 0,
+ "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:09.997",
+ "record_num": 2,
+ "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"
+ }
+ ]
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query private zones in list.
+GET /v2/zones?type={type}&limit={limit}&marker={marker}&offset={offset}&tags={tags}&name={name}&status={status}&enterprise_project_id={id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
type + |
+Yes + |
+String + |
+Zone type +The value is private, indicating that private zones are queried. + |
+
marker + |
+No + |
+String + |
+Start resource ID of pagination query +If the parameter is left blank, only resources on the first page are queried. +The value is left blank by default. + |
+
limit + |
+No + |
+Integer + |
+Number of resources on each page +The value ranges from 0 to 500. +Commonly used values are 10, 20, and 50. The default value is 500. + |
+
offset + |
+No + |
+Integer + |
+Start offset of pagination query. The query will start from the next resource of the offset value. +The value ranges from 0 to 2147483647. +The default value is 0. +If marker is not left blank, the query starts from the resource specified by marker. + |
+
tags + |
+No + |
+String + |
+Resource tag +The format is as follows: key1,value1|key2,value2. +Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,). +The tags are in AND relationship. +For details, see Adding Resource Tags. +The value is left blank by default. + |
+
name + |
+No + |
+String + |
+Zone name +A fuzzy search will be performed. + |
+
status + |
+No + |
+String + |
+Resource status +For details, see Resource Status. + |
+
enterprise_project_id + |
+No + |
+String + |
+Specifies the ID of the enterprise project associated with the private zone. The value contains a maximum of 36 characters. +The default value is 0. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+Object + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
zones + |
+Array of object + |
+Zone list. For details, see Table 3. + |
+
metadata + |
+Object + |
+Total number of resources that meet the filter criteria. For details, see Table 4. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
routers + |
+Array of object + |
+Routers (VPCs associated with the zone). For details, see Table 6. + |
+
enterprise_project_id + |
+String + |
+Specifies the ID of the enterprise project associated with the private zone. The value contains a maximum of 36 characters. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_count + |
+Integer + |
+Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
self + |
+String + |
+Link to the current resource + |
+
next + |
+String + |
+Link to the next page + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
router_id + |
+String + |
+ID of the associated VPC + |
+
router_region + |
+String + |
+Region of the VPC +If it is left blank, the region of the project in the token takes effect by default. + |
+
{
+ "links": {
+ "self": "https://Endpoint/v2/zones?type=private&limit=11",
+ "next": "https://Endpoint/v2/zones?type=private&limit=11&marker=ff8080825b8fc86c015b94bc6f8712c3"
+ },
+ "zones": [
+ {
+ "id": "ff8080825b8fc86c015b94bc6f8712c3",
+ "name": "example.com.",
+ "description": "This is an example zone.",
+ "email": "xx@example.com",
+ "ttl": 300,
+ "serial": 0,
+ "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:09.997",
+ "record_num": 2,
+ "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"
+ }
+ ]
+ },
+ {
+ "id": "ff8080825b95142f015b951f87280029",
+ "name": "example.org.",
+ "description": "This is an example zone.",
+ "email": "xx@example.org",
+ "ttl": 300,
+ "serial": 0,
+ "masters": [],
+ "status": "ACTIVE",
+ "links": {
+ "self": "https://Endpoint/v2/zones/ff8080825b95142f015b951f87280029"
+ },
+ "pool_id": "ff8080825ab738f4015ab7513298010e",
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
+ "zone_type": "private",
+ "created_at": "2017-04-22T08:17:08.997",
+ "updated_at": "2017-04-22T08:17:09.997",
+ "record_num": 2,
+ "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"
+ }
+ ]
+
+ }
+ ],
+ "metadata": {
+ "total_count": 2
+ }
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query name servers in a private zone.
+GET /v2/zones/{zone_id}/nameservers
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +You can obtain the value by calling the API in Querying Private Zones. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
nameservers + |
+Array of object + |
+Name server list object +For details, see Table 3. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
address + |
+String + |
+IP address of a DNS server + |
+
priority + |
+Integer + |
+Priority of a name server +For example, if the priority of a DNS server is 1, it is used to resolve domain names in first priority. + |
+
{
+ "nameservers": [
+ {
+ "priority": 1,
+ "address": "100.125.0.81"
+ },
+ {
+ "priority": 2,
+ "address": "100.125.0.82"
+ }
+ ]
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Delete a private zone.
+DELETE /v2/zones/{zone_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +You can obtain the value by calling the API in Querying Private Zones. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 3. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
routers + |
+Array of object + |
+Routers (VPCs associated with the zone). For details, see Table 4. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
self + |
+String + |
+Link to the current resource + |
+
next + |
+String + |
+Link to the next page + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
router_id + |
+String + |
+ID of the associated VPC + |
+
router_region + |
+String + |
+Region of the VPC +If it is left blank, the region of the project in the token takes effect by default. + |
+
{
+ "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"
+ }
+ ]
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Modify a private zone.
+PATCH /v2/zones/{zone_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+ID of the zone to be modified +You can obtain the value by calling the API in Querying Private Zones. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
description + |
+No + |
+String + |
+Description of the zone, which cannot exceed 255 characters +If this parameter is left blank, the value will not be changed. +The value is left blank by default. + |
+
No + |
+String + |
+Email address of the administrator managing the zone +If this parameter is left blank, the value will not be changed. +The value is left blank by default. + |
+|
ttl + |
+No + |
+Integer + |
+Caching period of the SOA record set (in seconds) +The value ranges from 1 to 2147483647. +If this parameter is left blank, the value will not be changed. +The value is left blank by default. + |
+
Modify the zone whose ID is 2c9eb155587194ec01587224c9f90149:
+PATCH https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149
+{
+ "description": "This is an example zone.",
+ "email": "xx@example.org",
+ "ttl": 300
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Zone ID, which is a UUID used to identify the zone + |
+
name + |
+String + |
+Zone name + |
+
description + |
+String + |
+Zone description + |
+
String + |
+Email address of the administrator managing the zone + |
+|
zone_type + |
+String + |
+Zone type, which can be public or private + |
+
ttl + |
+Integer + |
+TTL value of the SOA record set in the zone + |
+
serial + |
+Integer + |
+Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server +This parameter is not used currently. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
record_num + |
+Integer + |
+Number of record sets in the zone + |
+
pool_id + |
+String + |
+Pool ID of the zone, which is assigned by the system + |
+
project_id + |
+String + |
+Project ID of the zone + |
+
created_at + |
+String + |
+Time when the zone was created +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
updated_at + |
+String + |
+Time when the zone was updated +The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. + |
+
links + |
+Object + + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 4. + |
+
masters + |
+Array of strings + |
+Master DNS servers, from which the slave servers get DNS information +This parameter is not used currently. + |
+
routers + |
+Array of object + |
+Information about the VPC associated with the zone. For details, see Table 5. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
self + |
+String + |
+Link to the current resource + |
+
next + |
+String + |
+Link to the next page + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
router_id + |
+String + |
+ID of the associated VPC + |
+
router_region + |
+String + |
+Region of the VPC +If it is left blank, the region of the project in the token takes effect by default. + |
+
{
+ "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"
+ }
+ ]
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Create a record set.
+POST /v2/zones/{zone_id}/recordsets
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +Obtain the public zone ID according to Querying Public Zones. +Obtain the private zone ID according to Querying Private Zones. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+Yes + |
+String + |
+Fully qualified domain name (FQDN) suffixed with a zone name, which is a complete host name ended with a dot +A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters. + |
+
description + |
+No + |
+String + |
+(Optional) Description of the domain name +The value cannot exceed 255 characters. +The value is left blank by default. + |
+
type + |
+Yes + |
+String + |
+Record set type +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. + |
+
ttl + |
+No + |
+Integer + |
+Caching period of the record set on a local DNS server +If your service address is frequently changed, set TTL to a smaller value. +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
records + |
+Yes + |
+Array of strings + |
+Value of the record set. The value format varies depending on record set types. +For example, the value of an AAAA record set is the IPv6 address list mapped to the domain name. + |
+
tags + |
+No + |
+Array of object + |
+Resource tag. For details, see Table 3. +The value is left blank by default. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Tag key. The key contains 36 Unicode characters at most and cannot be blank. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
value + |
+No + |
+String + |
+Tag value. Each value contains 43 Unicode characters at most and can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
POST https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets
+{
+ "name": "www.example.com.",
+ "description": "This is an example record set.",
+ "type": "A",
+ "ttl": 3600,
+ "records": [
+ "192.168.10.1",
+ "192.168.10.2"
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+{
+ "name": "www.example.com.",
+ "description": "This is an example record set.",
+ "type": "AAAA",
+ "ttl": 3600,
+ "records": [
+ "fe80:0:0:0:202:b3ff:fe1e:8329",
+ "ff03:0db8:85a3:0:0:8a2e:0370:7334"
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+{
+ "name": "www.example.com.",
+ "description": "This is an example record set.",
+ "type": "MX",
+ "ttl": 3600,
+ "records": [
+ "1 mail.example.com"
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+{
+ "name": "sale.example.com.",
+ "description": "This is an example record set.",
+ "type": "CNAME",
+ "ttl": 3600,
+ "records": [
+ "server1.example.com"
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+{
+ "name": "server1.example.com.",
+ "description": "This is an example record set.",
+ "type": "TXT",
+ "ttl": 300,
+ "records": [
+ "\"This host is used for sale.\""
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+{
+ "name": "server1.example.com.",
+ "description": "This is an example record set.",
+ "type": "NS",
+ "ttl": 300,
+ "records": [
+ "node1.example.com.",
+ "node2.example.com."
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+{
+ "name": "_sip._tcp.example.com.",
+ "description": "This is an example record set.",
+ "type": "SRV",
+ "ttl": 300,
+ "records": [
+ "3 60 2176 sipserver.example.com.",
+ "10 100 2176 sipserver.example.com."
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+{
+ "name": "1.1.168.192.in-addr.arpa.",
+ "description": "This is an example record set.",
+ "type": "PTR",
+ "ttl": 300,
+ "records": [
+ "webserver.example.com."
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+
+{
+ "name": "www.example.com.",
+ "description": "This is an example record set.",
+ "type": "CAA",
+ "ttl": 300,
+ "records": [
+ "0 issue \"example.com\"",
+ "0 issuewild \"www.certinomis.com\"",
+ "0 iodef \"mailto:xx@example.org\"",
+ "0 iodef \"http://iodef.example.com\""
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Record set ID + |
+
name + |
+String + |
+Record set name + |
+
description + |
+String + |
+Record set description + |
+
zone_id + |
+String + |
+Zone ID of the record set + |
+
zone_name + |
+String + |
+Zone name of the record set + |
+
type + |
+String + |
+Record set type +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. + |
+
ttl + |
+Integer + |
+Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. + |
+
records + |
+Array of strings + |
+Record set value + |
+
create_at + |
+String + |
+Time when the record set was created +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
update_at + |
+String + |
+Time when the record set was updated +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
default + |
+Boolean + |
+Whether the record set is created by default. A default record set cannot be deleted. + |
+
project_id + |
+String + |
+Project ID of the record set + |
+
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
{
+ "id": "2c9eb155587228570158722b6ac30007",
+ "name": "www.example.com.",
+ "description": "This is an example record set.",
+ "type": "A",
+ "ttl": 300,
+ "records": [
+ "192.168.10.1",
+ "192.168.10.2"
+ ],
+ "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": null,
+ "default": false,
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query a record set.
+GET /v2/zones/{zone_id}/recordsets/{recordset_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +Obtain the public zone ID according to Querying Public Zones. +Obtain the private zone ID according to Querying Private Zones. + |
+
recordset_id + |
+Yes + |
+String + |
+Record set ID +You can obtain the value by calling the API in Querying Record Sets in a Zone. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Record set ID + |
+
name + |
+String + |
+Record set name + |
+
description + |
+String + |
+Record set description + |
+
zone_id + |
+String + |
+Zone ID of the record set + |
+
zone_name + |
+String + |
+Zone name of the record set + |
+
type + |
+String + |
+Record set type +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. + |
+
ttl + |
+Integer + |
+Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. + |
+
records + |
+Array of strings + |
+Record set value + |
+
create_at + |
+String + |
+Time when the record set was created +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
update_at + |
+String + |
+Time when the record set was updated +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
default + |
+Boolean + |
+Whether the record set is created by default +A default record set cannot be deleted. + |
+
project_id + |
+String + |
+Project ID of the record set + |
+
links + |
+Object + |
+Link to the current resource or other related resources +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 3. + |
+
{
+ "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"
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query record sets in list.
+GET /v2/recordsets?zone_type={zone_type}&limit={limit}&marker={marker}&offset={offset}&tags={tags}&status={status}&type={type}&name={name}&id={id}&records={records}&sort_key={sort_key}&sort_dir={sort_dir}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_type + |
+No + |
+String + |
+Zone type of the record set to be queried, which can be public or private +
A fuzzy search will be performed. +The default value is public. + |
+
marker + |
+No + |
+String + |
+Start resource ID of pagination query +If the parameter is left blank, only resources on the first page are queried. +The value is left blank by default. + |
+
limit + |
+No + |
+Integer + |
+Number of resources on each page +The value ranges from 0 to 500. +Commonly used values are 10, 20, and 50. The default value is 500. + |
+
offset + |
+No + |
+Integer + |
+Start offset of pagination query. The query will start from the next resource of the offset value. +The value ranges from 0 to 2147483647. +The default value is 0. +If marker is not left blank, the query starts from the resource specified by marker. + |
+
tags + |
+No + |
+String + |
+Resource tag +The format is as follows: key1,value1|key2,value2. +Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,). +The tags are in AND relationship. +For details, see Adding Resource Tags. +An exact match will be performed. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk. +The value is left blank by default. + |
+
|
+ status + |
+No + |
+String + |
+Status of the record sets to be queried +The value can be ACTIVE, ERROR, DISABLE, FREEZE, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. +For details, see Resource Status. +A fuzzy search will be performed. +The value is left blank by default. + |
+
type + |
+No + |
+String + |
+Type of the record sets to be queried +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. +An exact match will be performed. +The value is left blank by default. + |
+
name + |
+No + |
+String + |
+Names of record sets to be queried +A fuzzy search will be performed. +The value is left blank by default. + |
+
id + |
+No + |
+String + |
+IDs of record sets to be queried +A fuzzy search will be performed. +The value is left blank by default. + |
+
records + |
+No + |
+String + |
+Value included in the values of record sets to be queried +A fuzzy search will be performed. +The value is left blank by default. + |
+
sort_key + |
+No + |
+String + |
+Sorting condition of the record set list +The value can be: +
The default value is left blank, indicating that the records are not sorted. + |
+
sort_dir + |
+No + |
+String + |
+Sorting order of the record set list +The value can be: +
The default value is left blank, indicating that the records are not sorted. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
recordsets + |
+Array of object + |
+Record set list object. For details, see Table 3. + |
+
metadata + |
+Object + |
+Total number of resources that meet the filter criteria. For details, see Table 4. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Record set ID + |
+
name + |
+String + |
+Record set name + |
+
description + |
+String + |
+Record set description + |
+
zone_id + |
+String + |
+Zone ID of the record set + |
+
zone_name + |
+String + |
+Zone name of the record set + |
+
type + |
+String + |
+Record set type +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. + |
+
ttl + |
+Integer + |
+Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. + |
+
records + |
+Array of strings + |
+Record set value + |
+
create_at + |
+String + |
+Time when the record set was created +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
update_at + |
+String + |
+Time when the record set was updated +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
default + |
+Boolean + |
+Whether the record set is created by default +A default record set cannot be deleted. + |
+
project_id + |
+String + |
+Project ID of the record set + |
+
links + |
+Object + |
+Link to the current resource or other related resources +When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
{
+ "links": {
+ "self": "https://Endpoint/v2/recordsets",
+ "next": "https://Endpoint/v2/recordsets?id=&limit=11&marker=2c9eb155587194ec01587224c9f9014a"
+ },
+ "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-17T11: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-17T11:56:03.827",
+ "default": true,
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
+ },
+ {
+ "id": "2c9eb155587228570158722996ca0002",
+ "name": "example.org.",
+ "type": "SOA",
+ "ttl": 300,
+ "records": [
+ "ns1.hotrot.de. xx.example.org. (1 7200 900 1209600 300)"
+ ],
+ "status": "ACTIVE",
+ "links": {
+ "self": "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0002"
+ },
+ "zone_id": "2c9eb155587228570158722996c50001",
+ "zone_name": "example.org.",
+ "create_at": "2016-11-17T12:01:17.996",
+ "update_at": "2016-11-17T12:56:03.827",
+ "default": true,
+ "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
+ },
+ {
+ "id": "2c9eb155587228570158722996ca0004",
+ "name": "example.org.",
+ "type": "NS",
+ "ttl": 172800,
+ "records": [
+ "ns2.hotrot.de.",
+ "ns1.hotrot.de."
+ ],
+ "status": "ACTIVE",
+ "links": {
+ "self": "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0004"
+ },
+ "zone_id": "2c9eb155587228570158722996c50001",
+ "zone_name": "example.org.",
+ "create_at": "2016-11-17T12:01:17.996",
+ "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": "ACTIVE",
+ "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": 5
+ }
+}
+
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query all record sets in a specified zone.
+GET /v2/zones/{zone_id}/recordsets?limit={limit}&offset={offset}&marker={marker}&tags={tags}&status={status}&type={type}&name={name}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +Obtain the public zone ID according to Querying Public Zones. +Obtain the private zone ID according to Querying Private Zones. + |
+
marker + |
+No + |
+String + |
+Start resource ID of pagination query +If the parameter is left blank, only resources on the first page are queried. + |
+
limit + |
+No + |
+Integer + |
+Number of resources on each page +The value ranges from 0 to 500. +Commonly used values are 10, 20, and 50. The default value is 500. + |
+
offset + |
+No + |
+Integer + |
+Start offset of pagination query. The query will start from the next resource of the offset value. +The value ranges from 0 to 2147483647. +The default value is 0. +If marker is not left blank, the query starts from the resource specified by marker. + |
+
tags + |
+No + |
+String + |
+Resource tag +The format is as follows: key1,value1|key2,value2. +Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,). +The tags are in AND relationship. +For details, see Adding Resource Tags. +An exact match will be performed. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk. +The value is left blank by default. + |
+
|
+ status + |
+No + |
+String + |
+Status of the record sets to be queried +The value can be ACTIVE, ERROR, DISABLE, FREEZE, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. +For details, see Resource Status. +A fuzzy search will be performed. +The value is left blank by default. + |
+
type + |
+No + |
+String + |
+Type of the record sets to be queried +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. +An exact match will be performed. +The value is left blank by default. + |
+
name + |
+No + |
+String + |
+Name of record sets to be queried +A fuzzy search will be performed. +The value is left blank by default. + |
+
id + |
+No + |
+String + |
+ID of record sets to be queried +A fuzzy search will be performed. +The value is left blank by default. + |
+
sort_key + |
+No + |
+String + |
+Sorting condition of the record set list +The value can be: +
The default value is left blank, indicating that the records are not sorted. + |
+
sort_dir + |
+No + |
+String + |
+Sorting order of the record set list +The value can be: +
The default value is left blank, indicating that the records are not sorted. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
recordsets + |
+Array of object + |
+Record set list object. For details, see Table 3. + |
+
metadata + |
+Object + |
+Total number of resources that meet the filter criteria. For details, see Table 4. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Record set ID + |
+
name + |
+String + |
+Record set name + |
+
description + |
+String + |
+Record set description + |
+
zone_id + |
+String + |
+Zone ID of the record set + |
+
zone_name + |
+String + |
+Zone name of the record set + |
+
type + |
+String + |
+Record set type +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. + |
+
ttl + |
+Integer + |
+Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. + |
+
records + |
+Array of strings + |
+Record set value + |
+
create_at + |
+String + |
+Time when the record set was created +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
update_at + |
+String + |
+Time when the record set was updated +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
default + |
+Boolean + |
+Whether the record set is created by default. A default record set cannot be deleted. + |
+
project_id + |
+String + |
+Project ID of the record set + |
+
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 5. + |
+
{
+ "links": {
+ "self": "https://Endpoint/v2/recordsets?limit=1&marker=&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149",
+ "next": "https://Endpoint/v2/recordsets?limit=11&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
+ }
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Delete a record set.
+DELETE /v2/zones/{zone_id}/recordsets/{recordset_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +Obtain the public zone ID according to Querying Public Zones. +Obtain the private zone ID according to Querying Private Zones. + |
+
recordset_id + |
+Yes + |
+String + |
+ID of the record set to be deleted +You can obtain the value by calling the API in Querying Record Sets in a Zone. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Record set ID + |
+
name + |
+String + |
+Record set name + |
+
description + |
+String + |
+Record set description + |
+
zone_id + |
+String + |
+Zone ID of the record set + |
+
zone_name + |
+String + |
+Zone name of the record set + |
+
type + |
+String + |
+Record set type +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. + |
+
ttl + |
+Integer + |
+Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. + |
+
records + |
+Array of strings + |
+Record set value + |
+
create_at + |
+String + |
+Time when the record set was created +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
update_at + |
+String + |
+Time when the record set was updated +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
default + |
+Boolean + |
+Whether the record set is created by default. A default record set cannot be deleted. + |
+
project_id + |
+String + |
+Project ID of the record set + |
+
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 3. + |
+
{
+ "id": "2c9eb155587228570158722b6ac30007",
+ "name": "www.example.com.",
+ "description": "This is an example record set.",
+ "type": "A",
+ "ttl": 300,
+ "status": "PENDING_DELETE",
+ "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"
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Modify a record set.
+PUT /v2/zones/{zone_id}/recordsets/{recordset_id}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
zone_id + |
+Yes + |
+String + |
+Zone ID +Obtain the public zone ID according to Querying Public Zones. +Obtain the private zone ID according to Querying Private Zones. + |
+
recordset_id + |
+Yes + |
+String + |
+ID of the record set to be modified +You can obtain the value by calling the API in Querying Record Sets in a Zone. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+No + |
+String + |
+Fully qualified domain name (FQDN) suffixed with a zone name, which is a complete host name ended with a dot +If it is a record set in a public zone, you can add five labels at most. +A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters. + |
+
description + |
+No + |
+String + |
+(Optional) Description of the domain name +The value cannot exceed 255 characters. +If this parameter is left blank, the value will not be changed. +The value is left blank by default. + |
+
type + |
+No + |
+String + |
+Record set type +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, PTR (only in private zones), and CAA (only in public zones). +The value can be A, AAAA, MX, CNAME, TXT, SRV, or PTR (only in private zones). +For details, see Record Set Type. + |
+
ttl + |
+No + |
+Integer + |
+Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. +The value ranges from 1 to 2147483647. +If this parameter is left blank, the value will not be changed. +The value is left blank by default. + |
+
records + |
+No + |
+Array of strings + |
+Value of the record set. The value format varies depending on record set types. +For example, the value of an AAAA record set is the IPv6 address list mapped to the domain name. + |
+
Modify the record set whose ID is 2c9eb155587228570158722b6ac30007 in the zone whose ID is 2c9eb155587194ec01587224c9f90149:
+PUT https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007
+{
+ "description": "This is an example record set.",
+ "ttl": 3600,
+ "records": [
+ "192.168.10.1",
+ "192.168.10.2"
+ ]
+}
+{
+ "description": "This is an example record set.",
+ "ttl": 3600,
+ "records": [
+ "fe80:0:0:0:202:b3ff:fe1e:8329",
+ "ff03:0db8:85a3:0:0:8a2e:0370:7334"
+ ]
+}
+{
+ "description": "This is an example record set.",
+ "ttl": 3600,
+ "records": [
+ "1 mail.example.com"
+ ]
+}
+{
+ "description": "This is an example record set.",
+ "ttl": 3600,
+ "records": [
+ "server1.example.com"
+ ]
+}
+{
+ "description": "This is an example record set.",
+ "ttl": 300,
+ "records": [
+ "\"This host is used for sale.\""
+ ]
+}
+{
+ "description": "This is an example record set.",
+ "ttl": 300,
+ "records": [
+ "node1.example.com.",
+ "node2.example.com."
+ ]
+}
+{
+ "description": "This is an example record set.",
+ "ttl": 3600,
+ "records": [
+ "3 60 2176 sipserver.example.com.",
+ "10 100 2176 sipserver.example.com."
+ ]
+}
+{
+ "description": "This is an example record set.",
+ "ttl": 3600,
+ "records": [
+ "host.example.com."
+
+ ]
+}
+
+{
+ "description": "This is an example record set.",
+ "ttl": 300,
+ "records": [
+ "0 issue \"example.com\"",
+ "0 issuewild \"www.certinomis.com\"",
+ "0 iodef \"mailto:xx@example.org\"",
+ "0 iodef \"http://iodef.example.com\""
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Record set ID + |
+
name + |
+String + |
+Record set name + |
+
description + |
+String + |
+Record set description + |
+
zone_id + |
+String + |
+Zone ID of the record set + |
+
zone_name + |
+String + |
+Zone name of the record set + |
+
type + |
+String + |
+Record set type +The value can be A, AAAA, MX, CNAME, TXT, NS (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). +For details, see Record Set Type. + |
+
ttl + |
+Integer + |
+Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. + |
+
records + |
+Array of strings + |
+Record set value + |
+
create_at + |
+String + |
+Time when the record set was created +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
update_at + |
+String + |
+Time when the record set was updated +The value format is yyyy-MM-dd'T'HH:mm:ss.SSS. + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
default + |
+Boolean + |
+Whether the record set is created by default. A default record set cannot be deleted. + |
+
project_id + |
+String + |
+Project ID of the record set + |
+
links + |
+Object + |
+Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. +For details, see Table 4. + |
+
{
+ "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"
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+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-Project-Id in the request header to perform the operations. If you do not specify one, the default project of the token will be used.
+ +Create a PTR record for an elastic IP address (EIP).
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
ptrdname + |
+Yes + |
+String + |
+Domain name of the PTR record +A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters. + |
+
description + |
+No + |
+String + |
+PTR record description +The value is left blank by default. + |
+
ttl + |
+No + |
+Integer + |
+PTR record cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
enterprise_project_id + |
+No + |
+String + |
+Specifies the ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters. +The default value is 0. + |
+
tags + |
+No + |
+Array of object + |
+Resource tag. For details, see Table 3. +The value is left blank by default. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Tag key. The key contains 36 Unicode characters at most and cannot be blank. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
value + |
+No + |
+String + |
+Tag value. Each value contains 43 Unicode characters at most and can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
PATCH https://{DNS_Endpoint}/v2/reverse/floatingips/region_id:c5504932-bf23-4171-b655-b87a6bc59334
+{
+ "ptrdname": "www.example.com",
+ "description": "Description for this PTR record",
+ "ttl": 300,
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+PTR record ID, which is in {region}:{floatingip_id} format + |
+
ptrdname + |
+String + |
+Domain name of the PTR record + |
+
description + |
+String + |
+PTR record description + |
+
ttl + |
+Integer + |
+PTR record cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
address + |
+String + |
+EIP + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
action + |
+String + |
+Requested operation on the resource +The value can be CREATE, UPDATE, DELETE, or NONE. +NONE indicates that no operation will be performed. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. For details, see Table 5. + |
+
{
+ "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"
+ }
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query the PTR record of an EIP.
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+PTR record ID, which is in {region}:{floatingip_id} format + |
+
ptrdname + |
+String + |
+Domain name of the PTR record + |
+
description + |
+String + |
+PTR record description + |
+
ttl + |
+Integer + |
+PTR record cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
address + |
+String + |
+EIP + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
action + |
+String + |
+Requested operation on the resource +The value can be CREATE, UPDATE, DELETE, or NONE. +NONE indicates that no operation will be performed. + |
+
links + |
+Object + |
+Link to the current resource or other related resources +When a response is broken into pages, a next link is provided to retrieve all results. For details, see Table 3. + |
+
{
+ "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": "ACTIVE",
+ "links": {
+ "self": "https://Endpoint/v2/reverse/floatingips/region_id:c5504932-bf23-4171-b655-b87a6bc59334"
+ }
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query PTR records of EIPs.
+GET /v2/reverse/floatingips?limit={limit}&marker={marker}&offset={offset}&tags={tags}&status={status}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
marker + |
+No + |
+String + |
+Start resource ID of pagination query +If the parameter is left blank, only resources on the first page are queried. +The value is left blank by default. + |
+
limit + |
+No + |
+Integer + |
+Number of resources on each page +The value ranges from 0 to 500. +Commonly used values are 10, 20, and 50. The default value is 500. + |
+
offset + |
+No + |
+Integer + |
+Start offset of pagination query. The query will start from the next resource of the offset value. +The value ranges from 0 to 2147483647. +The default value is 0. +If marker is not left blank, the query starts from the resource specified by marker. + |
+
enterprise_project_id + |
+No + |
+String + |
+Specifies the ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters. +The default value is 0. + |
+
tags + |
+No + |
+String + |
+Resource tag +The format is as follows: key1,value1|key2,value2. +Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,). +The tags are in AND relationship. +For details, see Adding Resource Tags. +An exact match will be performed. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk. +The value is left blank by default. + |
+
status + |
+No + |
+String + |
+Resource status +For details, see Resource Status. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+Object + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. For details, see Table 5. + |
+
metadata + |
+Object + |
+Number of resources that meet the filter condition. For details, see Table 4. + |
+
floatingips + |
+Array of object + |
+PTR record object list. For details, see Table 3. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+PTR record ID, which is in {region}:{floatingip_id} format + |
+
ptrdname + |
+String + |
+Domain name of the PTR record + |
+
description + |
+String + |
+PTR record description + |
+
ttl + |
+Integer + |
+PTR record cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
address + |
+String + |
+EIP + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
action + |
+String + |
+Requested operation on the resource +The value can be CREATE, UPDATE, DELETE, or NONE. +NONE indicates that no operation will be performed. + |
+
links + |
+Object + |
+Link to the current resource or other related resources. +When a response is broken into pages, a next link is provided to retrieve all results. For details, see Table 5. + |
+
enterprise_project_id + |
+String + |
+Specifies the ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters. + |
+
{
+ "links": {
+ "self": "https://Endpoint/v2/reverse/floatingips",
+ "next": "https://Endpoint/v2/zones?id=&limit=1&marker=region_id:c5504932-bf23-4171-b655-b87a6bc59334"
+ },
+ "metadata": {
+ "total_count": 1
+ },
+ "floatingips": [
+ {
+ "id": "region_id:c5504932-bf23-4171-b655-b87a6bc59334",
+ "ptrdname": "www.example.com.",
+ "description": "Description for this PTR record",
+ "address": "10.154.52.138",
+ "action": "NONE",
+ "ttl": 300,
+ "status": "ACTIVE",
+ "links": {
+ "self": "https://Endpoint/v2/reverse/floatingips/region_id:c5504932-bf23-4171-b655-b87a6bc59334"
+ }
+ }
+ ]
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Unset the PTR record to the default value.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
ptrdname + |
+Yes + |
+String + |
+Domain name of the PTR record +Set it to null in the request. + |
+
None
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Modify the PTR record for an EIP.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
ptrdname + |
+Yes + |
+String + |
+Domain name of the PTR record +A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters. + |
+
description + |
+No + |
+String + |
+PTR record description +The value is left blank by default. + |
+
ttl + |
+No + |
+Integer + |
+PTR record cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
tags + |
+No + |
+Array of object + |
+Resource tag. For details, see Table 3. +It is left blank by default. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Tag key. The key contains 36 Unicode characters at most and cannot be blank. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
value + |
+No + |
+String + |
+Tag value. Each value contains 43 Unicode characters at most and can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+PTR record ID, which is in {region}:{floatingip_id} format + |
+
ptrdname + |
+String + |
+Domain name of the PTR record + |
+
description + |
+String + |
+PTR record description + |
+
ttl + |
+Integer + |
+PTR record cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. +If your service address is frequently changed, set TTL to a smaller value. +The value ranges from 1 to 2147483647. +The default value is 300. + |
+
address + |
+String + |
+EIP + |
+
status + |
+String + |
+Resource status +For details, see Resource Status. + |
+
action + |
+String + |
+Requested operation on the resource +The value can be CREATE, UPDATE, DELETE, or NONE (indicating that no operation will be performed). + |
+
links + |
+Object + |
+Link to the current resource or other related resources +When a response is broken into pages, a next link is provided to retrieve all results. For details, see Table 5. + |
+
{
+ "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"
+ }
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+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 will be created and overwrite the existing one.
+POST /v2/{project_id}/{resource_type}/{resource_id}/tags
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. You can obtain it in Obtaining a Project ID. + |
+
resource_type + |
+Yes + |
+String + |
+Resource type, which can be DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset, or DNS-ptr_record + |
+
resource_id + |
+Yes + |
+String + |
+Resource ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
tag + |
+Yes + |
+Object + |
+Tag +For details, see Table 3. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Tag key. The key contains 36 Unicode characters at most and cannot be blank. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
value + |
+No + |
+String + |
+Tag value. Each value contains 43 Unicode characters at most and can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
POST https://{DNS_Endpoint}/v2/{project_id}/DNS-private_zone/ff8080825b8fc86c015b94bc6f8712c3/tags
+{
+ "tag": {
+ "key": "key1",
+ "value": "value1"
+ }
+}
+None
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+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_type}/{resource_id}/tags/{key}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. You can obtain it in Obtaining a Project ID. + |
+
resource_type + |
+Yes + |
+String + |
+Resource type, which can be DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset, or DNS-ptr_record + |
+
resource_id + |
+Yes + |
+String + |
+Resource ID + |
+
key + |
+Yes + |
+String + |
+Tag key +The key cannot be left blank or be an empty string. + |
+
None
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+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.
+If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.
+POST /v2/{project_id}/{resource_type}/{resource_id}/tags/action
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. You can obtain it in Obtaining a Project ID. + |
+
resource_type + |
+Yes + |
+String + |
+Resource type, which can be DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset, or DNS-ptr_record + |
+
resource_id + |
+Yes + |
+String + |
+Resource ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
tags + |
+Yes + |
+Array of object + |
+Tag list. The tag list structure cannot be empty when you delete tags. For details, see Table 3. + |
+
action + |
+Yes + |
+String + |
+Operation, which can be create or delete (case sensitive) + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Tag key, which cannot be left blank or be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). +
|
+
value + |
+No + |
+String + |
+Tag value, which can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). +
|
+
POST https://{DNS_Endpoint}/v2/{project_id}/DNS-private_zone/ff8080825b8fc86c015b94bc6f8712c3/tags/action
+{
+ "action": "create",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+}
+or
+{
+ "action": "delete",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+}
+None
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query tags of a specified resource.
+GET /v2/{project_id}/{resource_type}/{resource_id}/tags
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. You can obtain it in Obtaining a Project ID. + |
+
resource_type + |
+Yes + |
+String + |
+Resource type, which can be DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset, or DNS-ptr_record + |
+
resource_id + |
+Yes + |
+String + |
+Resource ID + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Array of object + |
+Tag list. For details, see Table 2. + |
+
{
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query all tags of a resource type.
+GET /v2/{project_id}/{resource_type}/tags
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. You can obtain it in Obtaining a Project ID. + |
+
resource_type + |
+Yes + |
+String + |
+Resource type, which can be DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset, or DNS-ptr_record + |
+
None
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Array of object + |
+Tag list. For details, see Table 3. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Tag key. The key contains 36 Unicode characters at most and cannot be blank. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
values + |
+Array of strings + |
+Tag value, which contains 43 Unicode characters at most and can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
{
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ },
+ {
+ "key": "key2",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ]
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Query DNS resources by tag.
+Resources are sorted by creation time in descending order.
+POST /v2/{project_id}/{resource_type}/resource_instances/action
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. You can obtain it in Obtaining a Project ID. + |
+
resource_type + |
+Yes + |
+String + |
+Resource type, which can be DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset, or DNS-ptr_record + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
tags + |
+No + |
+Array of object + |
+Includes specified tags. For details, see Table 3. +The structure body is mandatory. A maximum of 20 tag keys are allowed in each query operation. The tag key cannot be left blank or set to the empty string. One tag key can have up to 10 tag values. Each tag key must be unique, and the tag values of one key must also be unique. + |
+
tags_any + |
+No + |
+Array of object + |
+Includes any of the specified tags. For details, see Table 3. +The structure body is mandatory. A maximum of 20 tag keys are allowed in each query operation. The tag key cannot be left blank or set to the empty string. One tag key can have up to 10 tag values. Each tag key must be unique, and the tag values of one key must also be unique. + |
+
not_tags + |
+No + |
+Array of object + |
+Excludes specified tags. For details, see Table 3. +The structure body is mandatory. A maximum of 20 tag keys are allowed in each query operation. The tag key cannot be left blank or set to the empty string. One tag key can have up to 10 tag values. Each tag key must be unique, and the tag values of one key must also be unique. + |
+
not_tags_any + |
+No + |
+Array of object + |
+Excludes any of the specified tags. For details, see Table 3. +The structure body is mandatory. A maximum of 20 tag keys are allowed in each query operation. The tag key cannot be left blank or set to the empty string. One tag key can have up to 10 tag values. Each tag key must be unique, and the tag values of one key must also be unique. + |
+
limit + |
+No + |
+Integer + |
+Number of resources on each page +The value range is 1–1000. +
|
+
offset + |
+No + |
+Integer + |
+Start offset of pagination query. The query will start from the next resource of the offset value. +The value ranges from 0 to 2147483647. +The default value is 0. +
|
+
action + |
+Yes + |
+String + |
+Operation to be performed +The value can be: +
|
+
matches + |
+No + |
+Array of object + |
+Field to be matched. For details, see Table 4. +This parameter specifies the key-value pair to be matched in the query. +If value is left blank, an exact match is performed. Otherwise, a fuzzy match is performed. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Tag key. A key contains 127 Unicode characters and cannot be blank. (This parameter is not verified in the search process.) + |
+
values + |
+Yes + |
+Array of strings + |
+Values of the tag. +A value contains a maximum of 255 Unicode characters. +The asterisk (*) is a reserved character. +If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk. +If this parameter is not specified, any value is matched. The values are in OR relationship. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Key to be matched. Currently, it can only be resource_name. + |
+
value + |
+Yes + |
+String + |
+Value to be matched. It contains a maximum of 255 Unicode characters and cannot contain underscores (_) and percent sign (%). + |
+
POST https://{DNS_Endpoint}/v2/{project_id}/DNS-private_zone/resource_instances/action
+{
+ "offset": "100",
+ "limit": "100",
+ "action": "filter",
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ }
+ ],
+ "not_tags": [
+ {
+ "key": "key1",
+ "values": [
+ "*value1",
+ "value2"
+ ]
+ }
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "*value1",
+ "value2"
+ ]
+ }
+ ],
+ "tags_any": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "not_tags_any": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ]
+}
+{
+ "action": "count",
+ "not_tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "*value2"
+ ]
+ }
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ },
+ {
+ "key": "key2",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "tags_any": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "not_tags_any": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resources + |
+Array of object + |
+Resource list For details, see Table 6. + |
+
total_count + |
+Integer + |
+Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resource_id + |
+String + |
+Resource ID + |
+
resource_detail + |
+String + |
+Resource details. This field is reserved for subsequent extension, and its value defaults to an empty string. + |
+
tags + |
+Array of object + |
+List of queried tags. If no tag is matched, an empty array is returned. For details, see Table 2. + |
+
resource_name + |
+String + |
+Resource name. If no resource name is matched, the value is left blank. + |
+
{
+ "resources": [
+ {
+ "resource_detail": null,
+ "resource_id": "cdfs_cefs_wesas_12_dsad",
+ "resource_name": "resouece1",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value1"
+ }
+ ]
+ }
+ ],
+ "total_count": 1000
+}
+{
+ "total_count": 1000
+}
+If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.
+For details, see Status Code.
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+Request succeeded. + |
+
202 + |
+Request accepted. + |
+
204 + |
+No content. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server fails to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The server cannot find the requested page. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server is not acceptable to the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. + |
+
408 Request Timeout + |
+The request is timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
413 Payload Too Large + |
+The request is too large. + |
+
500 internal Server Error + |
+The request fails because the server is abnormal. + |
+
501 Not Implemented + |
+The request fails because the server does not support the requested function. + |
+
502 Bad Gateway + |
+The request fails because the returned response is invalid. + |
+
503 Service Unavailable + |
+The request fails because the system is abnormal. + |
+
504 Gateway Timeout + |
+Gateway times out. + |
+
When an API call encounters an error, an error structure is returned. This section describes parameters of the DNS error codes.
+{
+ "code": "DNS.0001",
+ "message": "Internal error."
+}
+Category + |
+Status Code + |
+Error Code + |
+Message + |
+Description + |
+Handling Measure + |
+
|---|---|---|---|---|---|
General + |
+500 + |
+DNS.0000 + |
+The system is busy. Try again later. + |
+Unknown error. + |
+Retry the operation. If the error persists, contact customer service. + |
+
500 + |
+DNS.0001 + |
+Internal error. + |
+Internal error. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
400 + |
+DNS.0002 + |
+Invalid request. + |
+Invalid request. + |
+Check whether the request parameter is empty or invalid. + |
+|
500 + |
+DNS.0003 + |
+The system is busy. Try again later. + |
+DB exception. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
404 + |
+DNS.0004 + |
+No record sets found. + |
+No record sets found. + |
+Check whether the resource is available. + |
+|
401 + |
+DNS.0005 + |
+Authentication required. + |
+Authentication required. + |
+1. When calling an API, check whether the token is valid. +2. Check whether you have operation permission on the requested resources. + |
+|
400 + |
+DNS.0006 + |
+The limit parameter is invalid. + |
+The limit parameter is invalid. + |
+Check the value of limit in the request. + |
+|
400 + |
+DNS.0007 + |
+The marker parameter is invalid. + |
+The marker parameter is invalid. + |
+Check the value of marker in the request. + |
+|
400 + |
+DNS.0008 + |
+The zone of this type is not supported now. + |
+The zone of this type is not supported now. + |
+Check the zone type and try again. + |
+|
400 + |
+DNS.0009 + |
+The startTime parameter is invalid. + |
+The startTime parameter is invalid. + |
+Check the value of startTime in the request. + |
+|
400 + |
+DNS.0010 + |
+The endTime parameter is invalid. + |
+The endTime parameter is invalid. + |
+Check the value of endTime in the request. + |
+|
400 + |
+DNS.0011 + |
+The Start parameter is invalid. + |
+The start parameter is invalid. + |
+Check the value of start in the request. + |
+|
500 + |
+DNS.0012 + |
+An error occurred when the VPC service is called. + |
+An error occurred when the VPC service is called. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
403 + |
+DNS.0013 + |
+You do not have the permission to perform this operation using the API. + |
+You do not have the permission to perform this operation using the API. + |
+The project of the requested resource may be frozen. Log in to the IAM console with the domain account and check whether the project status is normal. + |
+|
403 + |
+DNS.0014 + |
+Request forbidden by flow control. + |
+Request forbidden by flow control. + |
+Try again some time later. + |
+|
500 + |
+DNS.0015 + |
+An error occurred when the IAM service is called. + |
+An error occurred when the IAM service is called. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
400 + |
+DNS.0016 + |
+This record already exists or conflicts with another record. + |
+This record already exists. + |
+Check the record. + |
+|
400 + |
+DNS.0017 + |
+The offset parameter is invalid. + |
+The offset parameter is invalid. + |
+Check the value of offset in the request. + |
+|
409 + |
+DNS.0021 + |
+Could not acquire the lock, please try again later. + |
+Failed to obtain the lock. + |
+Try again later. + |
+|
400/500 + |
+DNS.0022 + |
+An error occurred when the Cloud Eye service is called. + |
+An error occurred when Cloud Eye is called. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
500 + |
+DNS.0023 + |
+An error occurred when the Cloud Eye service is called. Cloud Eye service response: Read timed out. + |
+An error occurred when the Cloud Eye service is called (Read timed out). + |
+Retry the operation. If the error persists, contact customer service. + |
+|
500 + |
+DNS.0024 + |
+An error occurred when the Cloud Eye service is called. Connect to Cloud Eye service failed: Connection refused. + |
+An error occurred when the Cloud Eye service is called (Connection refused). + |
+Retry the operation. If the error persists, contact customer service. + |
+|
500 + |
+DNS.0025 + |
+An error occurred when the Cloud Eye service is called. Connect to Cloud Eye service failed: connect timed out. + |
+An error occurred when the Cloud Eye service is called (Read timed out). + |
+Retry the operation. If the error persists, contact customer service. + |
+|
500 + |
+DNS.0026 + |
+Invalid CES endpoint configuration. + |
+Invalid Cloud Eye endpoint configuration. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
413 + |
+DNS.0027 + |
+Warning: upload file too large. + |
+The file to be uploaded is oversized. + |
+The request body is too large. + |
+|
400 + |
+DNS.0028 + |
+Invalid version. + |
+Invalid version number. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
400 + |
+DNS.0029 + |
+Invalid record. + |
+The record parameter is invalid. + |
+Check the value of offset in the request. + |
+|
403 + |
+DNS.0030 + |
+Operation not allowed for this resource. + |
+This operation is not allowed for the requested resource. + |
+Check whether you have operation permission on the requested resources. + |
+|
403 + |
+DNS.0031 + |
+User not allowed. + |
+You do not have permission to perform this operation. + |
+1. When calling an API, check whether the token is valid. +2. Check whether you have operation permission on the requested resources. + |
+|
400 + |
+DNS.0032 + |
+Invalid sort key. + |
+The sort key parameter is invalid. + |
+Check the value of sort key in the request. + |
+|
400 + |
+DNS.0033 + |
+Invalid sort dir. + |
+The sort dir parameter is invalid. + |
+Check the value of sort dir in the request. + |
+|
400/404/500 + |
+DNS.0034 + |
+An error occurred when the bss service is called. + |
+The system fails to call the BSS service. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
400/404/500 + |
+DNS.0035 + |
+An error occurred when the Cloudsite service is called. + |
+The system fails to call CloudSite. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
400 + |
+DNS.0036 + |
+An error occurred when the neutron service is called. + |
+The system fails to call the Neutron service. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
403 + |
+DNS.0037 + |
+Feature not supported now. + |
+This function is not available currently. + |
+This function is not available currently. + |
+|
400 + |
+DNS.0038 + |
+The show detail parameter is invalid. + |
+The show detail parameter is invalid. + |
+Check the value of show detail in the request. + |
+|
Pool + |
+400 + |
+DNS.0101 + |
+Invalid pool name. + |
+Invalid pool name. + |
+Check the pool name in the request. + |
+
400 + |
+DNS.0102 + |
+Invalid pool description. + |
+Invalid pool description. + |
+Check the pool description in the request. + |
+|
400 + |
+DNS.0103 + |
+Invalid pool type. + |
+Invalid pool type. + |
+Check whether the pool type you specify is supported or valid. + |
+|
400 + |
+DNS.0104 + |
+Invalid server configuration in the pool. + |
+Invalid server configuration in the pool. + |
+Check the host configuration in the pool. + |
+|
400 + |
+DNS.0105 + |
+Invalid name server configuration in the pool. + |
+Invalid name server configuration in the pool. + |
+Check the name server configuration. + |
+|
400 + |
+DNS.0106 + |
+Invalid pool region. + |
+Invalid region for parameter pool. + |
+Check the region configuration. + |
+|
400 + |
+DNS.0107 + |
+Invalid pool ID. + |
+Invalid pool ID. + |
+Check the pool ID in the request. + |
+|
404 + |
+DNS.0108 + |
+This pool does not exist. + |
+This pool does not exist. + |
+Check whether the pool is available. + |
+|
400 + |
+DNS.0109 + |
+This pool is in use. + |
+This pool is in use. + |
+A pool in use cannot be deleted. Contact customer service. + |
+|
Zone + |
+400 + |
+DNS.0201 + |
+The email address of the zone is invalid. + |
+The email address of the zone is invalid. + |
+Check the email address in the request. + |
+
400 + |
+DNS.0202 + |
+Invalid zone name. + |
+Invalid zone name. + |
+1. Check whether the zone name format is correct. +2. Ensure that the zone name cannot be a top-level or public second-level domain name. + |
+|
400 + |
+DNS.0203 + |
+Invalid zone TTL value. The value ranges from %s to %s. + |
+Invalid zone TTL value. The value ranges from {minTTL} to {maxTTL}. + |
+Check the TTL value in the request. If the limit does not meet your requirements, contact customer service. + |
+|
400 + |
+DNS.0204 + |
+Invalid zone type. + |
+Invalid zone type. + |
+Check whether the zone type you specify is supported. + |
+|
404/500 + |
+DNS.0205 + |
+No pools available. + |
+No pools available. + |
+Contact customer service. + |
+|
400 + |
+DNS.0206 + |
+Invalid zone description. The description can contain a maximum of 255 characters. + |
+Invalid zone description. The description can contain a maximum of 255 characters. + |
+Check the zone description in the request. + |
+|
500 + |
+DNS.0207 + |
+No views available in the pool. + |
+No views available. + |
+Contact customer service. + |
+|
400 + |
+DNS.0208 + |
+This zone already exists. + |
+This zone already exists. + |
+Check whether the requested zone already exists. + |
+|
400/409/500 + |
+DNS.0209 + |
+The zone is not in the Normal state. + |
+The zone is not in the normal state. + |
+The zone status is not stable. Try again later. + |
+|
400 + |
+DNS.0210 + |
+The zone name is used by the system. + |
+The zone name is used by the system. + |
+Check the zone name in the request. + |
+|
400 + |
+DNS.0211 + |
+The zone name is used by another tenant. + |
+The zone name is used by another tenant. + |
+Check the zone name in the request. + |
+|
400/409 + |
+DNS.0212 + |
+This VPC has already been associated with the zone. + |
+This VPC has already been associated with the zone. + |
+Check whether that the VPC has been associated with the private zone. + |
+|
400 + |
+DNS.0213 + |
+The zone is disabled. + |
+The domain name has been suspended. + |
+Check the zone status. + |
+|
Record set + |
+400 + |
+DNS.0301 + |
+Invalid zone ID. + |
+Invalid zone ID. + |
+Check the zone ID in the request. + |
+
400/404 + |
+DNS.0302 + |
+This zone does not exist. + |
+This zone does not exist. + |
+Check the zone of the requested record set. + |
+|
400 + |
+DNS.0303 + |
+Invalid record set TTL value. + |
+Invalid record set TTL value. + |
+Check the TTL value in the request. + |
+|
400 + |
+DNS.0304 + |
+Invalid record set name. + |
+Invalid record set name. + |
+Check whether the record set name is a valid domain name ended with the zone name. + |
+|
400 + |
+DNS.0305 + |
+Invalid record set description. The description can contain a maximum of 255 characters. + |
+Invalid record set description. The description can contain a maximum of 255 characters. + |
+Check the record set description in the request. + |
+|
400 + |
+DNS.0307 + |
+Invalid record set type. + |
+Invalid record set type. + |
+Check whether the record set type you specify is supported. + |
+|
400 + |
+DNS.0308 + |
+Invalid record set value. + |
+Invalid record set value. + |
+Check whether the record set value you specify is well-formatted. + |
+|
400 + |
+DNS.0309 + |
+Invalid record set ID. + |
+Invalid record set ID. + |
+Check the record set ID in the request. + |
+|
400/403 + |
+DNS.0310 + |
+Invalid tenant ID. + |
+Invalid tenant ID. + |
+Check whether the tenant ID is empty or in incorrect format. + |
+|
400/403 + |
+DNS.0311 + |
+Invalid domain ID. + |
+Invalid domain ID. + |
+Check whether the domain ID is empty or in incorrect format. + |
+|
400 + |
+DNS.0312 + |
+This record set name already exists. + |
+This record set already exists. + |
+Check whether the record set name already exists. + |
+|
404 + |
+DNS.0313 + |
+This record set does not exist. + |
+This record set does not exist. + |
+Check the requested record set. + |
+|
400/409 + |
+DNS.0314 + |
+The record set is not in a steady state. + |
+The record set is not in a steady state. + |
+Check the record set status. If it is not stable, you cannot perform operations. + |
+|
400 + |
+DNS.0315 + |
+Invalid status. + |
+Invalid status. + |
+Check the status in the request. + |
+|
400/409 + |
+DNS.0317 + |
+This record set is a default one and cannot be deleted. + |
+This record set is a default one and cannot be deleted. + |
+Check whether the record set to be deleted is created by default. + |
+|
400/409 + |
+DNS.0318 + |
+This record set is a default one and cannot be updated. + |
+This record set is a default one and cannot be updated. + |
+Check whether the record set to be updated is created by default. + |
+|
400 + |
+DNS.0319 + |
+The TTL parameter has been out of range. + |
+The TTL value is out of range. The value ranges from {minTTL} to {maxTTL}. + |
+Check the TTL value in the request. If the limit does not meet your requirements, contact customer service. + |
+|
400 + |
+DNS.0320 + |
+The Zone name levels have been out of MAX count. The maximum is %s. + |
+The zone name levels have been out of MAX count. The maximum is {maxLevel}. + |
+Check the domain name level in the request. + |
+|
400 + |
+DNS.0321 + |
+The sub domain levels have been out of MAX count. + |
+The subdomain levels have been out of MAX count. The maximum is {maxLevel}. + |
+Check the subdomain name in the request. + |
+|
400 + |
+DNS.0322 + |
+The number of weighted record sets with the same name, type, and resolution line has reached the limit %s. + |
+The number of record sets of the same name, type, and resolution line exceeds the limit. + |
+If the limit does not meet your requirements, contact customer service. + |
+|
400 + |
+DNS.0323 + |
+The weight must range from %s to %s. + |
+The weight must range from 0 to 100. + |
+Change the weight value. + |
+|
400 + |
+DNS.0324 + |
+This record set is a default one and cannot be operated. + |
+You cannot perform this operation on a default record set. + |
+You cannot perform this operation on a default record set. + |
+|
400 + |
+DNS.0325 + |
+The resolution line for record sets in this type of zones must be 'default_view'. + |
+The resolution line for record sets in this type of zones must be default_view. + |
+Change the resolution line in the request. + |
+|
400 + |
+DNS.0326 + |
+The batch number has been out of MAX count. The maximum is %s. + |
+The batch number has been out of MAX count. + |
+Modify the request parameter. + |
+|
400 + |
+DNS.0327 + |
+The batch number has been out of MAX count. The maximum is %s. + |
+The batch number has been out of MAX count. + |
+Modify the request parameter. + |
+|
400 + |
+DNS.0328 + |
+Cannot create this record set because the same one already exists but is not weighted. Specify a weight for the previous record set first. + |
+Specify a weight for the previous record set first. + |
+Specify a weight for the previous record set first. + |
+|
400 + |
+DNS.0329 + |
+The batch number has been out of MAX count. The maximum is %s. + |
+The number of requested resources has exceeded the limit. + |
+Modify the request parameter. + |
+|
400 + |
+DNS.0330 + |
+Invalid alias resource type. + |
+The resource type of parameter alias is invalid. + |
+Check the resource type of the alias. + |
+|
400 + |
+DNS.0331 + |
+Invalid alias resource domain name. + |
+The domain name of parameter alias is invalid. + |
+Check the value of alias in the request. + |
+|
400 + |
+DNS.0332 + |
+The alias must be a domain name of a cloud resource. + |
+The alias domain name must be hosted on the DNS server. + |
+Check the value of alias in the request. + |
+|
400 + |
+DNS.0333 + |
+The alias is not supported now. + |
+Alias records are not supported. + |
+Contact customer service. + |
+|
Quota + |
+400 + |
+DNS.0401 + |
+Invalid quota type. + |
+Invalid quota type. + |
+Check the quota type in the request. + |
+
400 + |
+DNS.0402 + |
+Invalid quota value. + |
+Invalid quota value. + |
+The quota value exceeds the limit. Contact customer service. + |
+|
403 + |
+DNS.0403 + |
+Insufficient record set quota. + |
+Insufficient record set quota. + |
+The number of record sets exceeds the quota limit. If the limit does not meet your requirements, contact customer service. + |
+|
403 + |
+DNS.0404 + |
+Insufficient zone quota. + |
+Insufficient zone quota. + |
+The number of zones exceeds the quota limit. If the limit does not meet your requirements, contact customer service. + |
+|
403 + |
+DNS.0405 + |
+Insufficient PTR record quota. + |
+Insufficient PTR record quota. + |
+The number of PTR records exceeds the quota limit. If the limit does not meet your requirements, contact customer service. + |
+|
403 + |
+DNS.0406 + |
+Insufficient inbound endpoint quota. + |
+Insufficient inbound rule quota. + |
+The number of inbound endpoints has reached the upper limit. If the limit does not meet your requirements, contact customer service. + |
+|
403 + |
+DNS.0407 + |
+Insufficient outbound endpoint quota. + |
+Insufficient outbound rule quota. + |
+The number of outbound endpoints has reached the upper limit. If the limit does not meet your requirements, contact customer service. + |
+|
403 + |
+DNS.0408 + |
+Insufficient custom line quota. + |
+Insufficient custom line quota. + |
+The number of custom lines has reached the limit. If the limit does not meet your requirements, contact customer service. + |
+|
403 + |
+DNS.0409 + |
+Insufficient line group quota. + |
+Insufficient line group quota. + |
+The number of line groups has reached the limit. If the limit does not meet your requirements, contact customer service. + |
+|
PTR record + |
+400 + |
+DNS.0501 + |
+Invalid PTR ID. + |
+Invalid PTR record ID. + |
+Check whether the PTR record ID is empty or in incorrect format. + |
+
404 + |
+DNS.0502 + |
+This EIP address does not exist. + |
+The EIP does not exist. + |
+Check whether the EIP is available. + |
+|
409 + |
+DNS.0503 + |
+The PTR record is not in a steady state. + |
+The PTR record is not in a steady state. + |
+Check the PTR record status. If it is not stable, you cannot perform operations. + |
+|
400/500 + |
+DNS.0504 + |
+Invalid EIP address ID. + |
+Invalid EIP ID. + |
+Check whether the EIP ID is empty or in incorrect format. + |
+|
400 + |
+DNS.0505 + |
+Invalid domain name in the PTR record. + |
+Invalid domain name in the PTR record. + |
+Check the domain name in the PTR record. + |
+|
400 + |
+DNS.0506 + |
+Invalid PTR TTL value. The value must range from %s to %s. + |
+Invalid PTR record TTL value. The value ranges from 1 to 2147483647. + |
+Check whether the PTR record TTL value exceeds the limit. + |
+|
404 + |
+DNS.0507 + |
+This PTR record does not exist. + |
+This PTR record does not exist. + |
+Check the requested PTR record. + |
+|
400 + |
+DNS.0508 + |
+Invalid PTR description. The description can contain a maximum of 255 characters. + |
+Invalid PTR record description. The description can contain a maximum of 255 characters. + |
+Check whether the PTR record description in the request exceeds 255 characters. + |
+|
400 + |
+DNS.0601 + |
+Invalid region. + |
+Invalid region. + |
+Check the value of region in the request. + |
+|
400 + |
+DNS.0602 + |
+Invalid floating IP address. + |
+Invalid floating IP address. + |
+Check the floating IP address in the request. + |
+|
400 + |
+DNS.0603 + |
+Invalid request. + |
+Invalid input. + |
+Check whether the request parameter is empty. + |
+|
400 + |
+DNS.0604 + |
+The interval parameter is invalid. + |
+The interval parameter is invalid. + |
+Check the value of interval in the request. + |
+|
400 + |
+DNS.0608 + |
+This resource is in use. + |
+This resource is in use. + |
+Check whether the resource is in use. + |
+|
Associating or disassociating a VPC from a private zone + |
+400 + |
+DNS.0701 + |
+Invalid VPC. + |
+Invalid VPC. + |
+Check the VPC ID and region in the request. + |
+
400 + |
+DNS.0704 + |
+The VPC is not in a steady state. + |
+The VPC is not in a steady state. + |
+Check whether the zone and VPC are normally associated. + |
+|
400 + |
+DNS.0705 + |
+No VPCs are associated with this zone. + |
+No VPCs are associated with this zone. + |
+Associate the zone with a VPC and try again. + |
+|
403 + |
+DNS.0706 + |
+You are not allowed to disassociate this VPC because this is the last VPC associated with this zone. + |
+You are not allowed to disassociate this VPC because this is the last VPC associated with this zone. + |
+Associate another VPC with the zone and then disassociate the previous one. + |
+|
400 + |
+DNS.0707 + |
+The VPC is not associated with the zone. + |
+The VPC is not associated with the zone. + |
+Check whether the zone is associated with the VPC. + |
+|
400 + |
+DNS.0708 + |
+This VPC cannot be disassociated because it is being associated with the zone. + |
+This VPC cannot be disassociated because it is being associated with the zone. + |
+Check the association status between the zone and VPC. Disassociate them when the status is stable. + |
+|
403 + |
+DNS.0709 + |
+This VPC cannot be disassociated because this is the only normal VPC associated with this zone. + |
+This VPC cannot be disassociated because this is the only normal VPC associated with this zone. + |
+Check whether other VPCs are normally associated with the zone. If no, perform the following operations: +1. Disassociate VPCs in abnormal association state. +2. Associate another VPC. +3. Disassociate the required VPC. + |
+|
500 + |
+DNS.0710 + |
+Invalid VPC URL configuration. + |
+Invalid VPC endpoint configuration. + |
+Check the region in the request. If the region is correct, contact customer service. + |
+|
404 + |
+DNS.0711 + |
+This VPC could not be found. + |
+This VPC could not be found. + |
+Log in to the VPC console and check whether the VPC exists. + |
+|
400 + |
+DNS.0712 + |
+This port parameter is invalid. + |
+The port ID is invalid. + |
+Check whether the port ID in the request is empty. + |
+|
400/500 + |
+DNS.0805 + |
+Failed to check the VPC validity. + |
+Failed to check the VPC validity. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
Name server + |
+404 + |
+DNS.0901 + |
+The name server does not exist. + |
+The name server does not exist. + |
+Contact customer service. + |
+
Tag + |
+400 + |
+DNS.1001 + |
+Insufficient tag quota. + |
+Insufficient tag quota. + |
+The number of tags reaches the quota limit. If the limit does not meet your requirements, contact customer service. + |
+
400 + |
+DNS.1002 + |
+Invalid resource type. + |
+Invalid resource type. + |
+Check the resource type in the request. + |
+|
400 + |
+DNS.1003 + |
+Invalid tag. + |
+Invalid tag. + |
+Check the tag in the request. + |
+|
Health check + |
+400 + |
+DNS.1101 + |
+Health check is currently not supported. + |
+Health check is currently not supported. + |
+Health check is currently not supported. + |
+
400 + |
+DNS.1102 + |
+Invalid health check ID. + |
+Invalid health check ID. + |
+Change the health check ID in the request. + |
+|
400 + |
+DNS.1103 + |
+This health check is disabled. + |
+This health check is disabled. + |
+1. Check whether the health check is disabled. +2. Enable the health check. + |
+|
400 + |
+DNS.1104 + |
+This record set has already been associated with a health check. + |
+This record set has already been associated with a health check. + |
+One record set can be associated with only one health check. + |
+|
404 + |
+DNS.1105 + |
+No health check is associated with this record set. + |
+No health check is associated with this record set. + |
+No health check is associated with this record set. + |
+|
404 + |
+DNS.1106 + |
+Cannot find the health check. + |
+Cannot find the health check. + |
+Change the health check ID in the request. + |
+|
400 + |
+DNS.1107 + |
+Insufficient health check quota. Contact customer service to increase quotas. + |
+Insufficient health check quota. + |
+Contact customer service. + |
+|
400 + |
+DNS.1108 + |
+Cannot associate the health check with the record set because its network plane does not match the zone type of the record set. + |
+Cannot associate the health check with the record set because its network plane does not match the zone type of the record set. + |
+Change the ID of the health check to be associated. + |
+|
400 + |
+DNS.1109 + |
+This health check is in detecting status and not available currently. + |
+This health check is in detecting status and not available currently. + |
+Try again later. + |
+|
500 + |
+DNS.1110 + |
+Invalid CES health check region configuration. + |
+Invalid health check region configuration. + |
+Contact customer service. + |
+|
Importing and exporting record sets + |
+400 + |
+DNS.1301 + |
+Failed to parse this upload file. + |
+Failed to obtain data from the uploaded file. + |
+Check the uploaded file. + |
+
400 + |
+DNS.1302 + |
+Empty upload file. + |
+The uploaded file is empty. + |
+Check the uploaded file. + |
+|
400 + |
+DNS.1303 + |
+Only .xlsx files are supported. + |
+Only .xlsx files are supported. + |
+Check the uploaded file. + |
+|
400 + |
+DNS.1304 + |
+Invalid task ID. + |
+Invalid task ID. + |
+Check the task ID. + |
+|
400 + |
+DNS.1305 + |
+Invalid record set type. + |
+Invalid record set type. + |
+Check the task ID. + |
+|
400 + |
+DNS.1306 + |
+Stop export: too many row exceed max limit. + |
+The number of exported record sets exceeds the maximum. + |
+Contact customer service. + |
+|
DNS package + |
+400 + |
+DNS.1401 + |
+Invalid package name. + |
+Invalid package name. + |
+Check the package name. + |
+
400 + |
+DNS.1402 + |
+Failed to purchase the DNS package. + |
+Failed to purchase the DNS package. + |
+Check the package name. + |
+|
404 + |
+DNS.1403 + |
+The package does not exist. + |
+The package does not exist. + |
+Check the package ID. + |
+|
Endpoint + |
+400 + |
+DNS.1501 + |
+Invalid endpoint name. + |
+Invalid endpoint name. + |
+Check the endpoint name. + |
+
400 + |
+DNS.1502 + |
+Invalid subnet id. + |
+Invalid subnet ID. + |
+Check the subnet ID. + |
+|
400 + |
+DNS.1503 + |
+Invalid endpoint direction. + |
+Invalid endpoint direction. + |
+Check the endpoint direction. + |
+|
400 + |
+DNS.1504 + |
+Endpoint name exists. + |
+The endpoint name already exists. + |
+Change the endpoint name. + |
+|
400 + |
+DNS.1505 + |
+Ip is not in this subnet. + |
+The IP address is not in the subnet. + |
+Enter an IP address within the subnet. + |
+|
400 + |
+DNS.1506 + |
+Ip is repeated. + |
+The IP address already exists. + |
+The IP address already exists. Change the IP address you entered. + |
+|
400 + |
+DNS.1507 + |
+Ip has been used. + |
+The IP address has been used. + |
+Change the IP address. + |
+|
400 + |
+DNS.1508 + |
+Subnets are in the different vpc. + |
+The subnets do not belong to the same VPC. + |
+Check the subnet information. + |
+|
400 + |
+DNS.1509 + |
+Invalid endpoint id. + |
+Invalid endpoint ID. + |
+Enter a correct endpoint ID. + |
+|
404 + |
+DNS.1510 + |
+Endpoint not exist. + |
+The endpoint does not exist. + |
+Check the endpoint ID. + |
+|
404 + |
+DNS.1511 + |
+Ipaddress not exist. + |
+The IP address does not exist. + |
+Change the IP address you entered. + |
+|
400 + |
+DNS.1514 + |
+Invalid number of ipaddress. + |
+Invalid IP address quantity. + |
+Check whether the number of IP addresses is in the range of 2 to 6. + |
+|
400 + |
+DNS.1515 + |
+Ip address is invalid. + |
+Invalid IP address. + |
+Check the IP address you entered. + |
+|
400 + |
+DNS.1516 + |
+Ip address is broadcast ipaddress or network ipaddress. + |
+The IP address is a network address or broadcast address. + |
+Check whether the IP address you entered is a broadcast address or network address. + |
+|
Resolution line + |
+400 + |
+DNS.0806 + |
+This line is not be supported in this DNS version. + |
+This line is not supported in this DNS version. + |
+Check the resolution line name in the request. + |
+
409 + |
+DNS.0807 + |
+This line is a default one and cannot be operated. + |
+This line is a default one and cannot be operated. + |
+Check the resolution line name in the request. + |
+|
400 + |
+DNS.1601 + |
+Invalid line ID. + |
+Invalid resolution line ID. + |
+Check the resolution line ID in the request. + |
+|
400 + |
+DNS.1602 + |
+Invalid line name. + |
+Invalid resolution line name. + |
+Check the resolution line name in the request. + |
+|
400 + |
+DNS.1603 + |
+The line name already exists. + |
+The resolution line name has been used. + |
+Change the resolution line name in the request. + |
+|
404 + |
+DNS.1604 + |
+The line does not exist. + |
+The resolution line does not exist. + |
+Check the resolution line in the request. + |
+|
400 + |
+DNS.1605 + |
+Invalid IP address range. + |
+Invalid IP address range. + |
+Check the IP address range in the request. + |
+|
400 + |
+DNS.1606 + |
+The IP address range overlaps with that in another line. + |
+The IP address ranges overlap. + |
+1. Check whether the IP address ranges in the request overlap each other. +2. Check whether the IP address ranges overlap those in other lines. + |
+|
409 + |
+DNS.1607 + |
+This line is not in a steady state. + |
+The resolution line is in the unstable state. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
400 + |
+DNS.1608 + |
+The IP segments has been out of MAX count. + |
+The number of IP address ranges exceeds the maximum. + |
+Check the number of IP address ranges in the request. + |
+|
Fine-grained policy + |
+500 + |
+DNS.1801 + |
+An error occurred when the IAM PDP service is called. + |
+The IAM PDP service cannot be properly called. + |
+Retry the operation. If the error persists, contact customer service. + |
+
403 + |
+DNS.1802 + |
+Policy doesn't allow {action} to be performed. + |
+You do not have permission to perform this operation. + |
+Check the permission of the user group. + |
+|
Enterprise project + |
+403 + |
+DNS.1900 + |
+Enterprise project is not supported. + |
+Enterprise projects are not supported. + |
+Contact customer service. + |
+
500 + |
+DNS.1901 + |
+Invalid EPS endpoint configuration. + |
+Invalid EPS endpoint configuration. + |
+Contact customer service. + |
+|
500 + |
+DNS.1902 + |
+An error occurred when the EPS service is called. + |
+The system fails to call the EPS service. + |
+Retry the operation. If the error persists, contact customer service. + |
+|
400 + |
+DNS.1903 + |
+Cannot associate the enterprise project. + |
+The selected enterprise project cannot be associated. + |
+1. Check whether the enterprise project is in normal status. +2. Check whether you have permission of the enterprise project. + |
+|
400 + |
+DNS.1904 + |
+This enterprise project is disabled. + |
+The enterprise project is disabled. + |
+Check the enterprise project. + |
+|
400 + |
+DNS.1905 + |
+Invalid enterprise project ID. + |
+Invalid enterprise project ID. + |
+Check the enterprise project ID. + |
+|
404 + |
+DNS.1906 + |
+The enterprise project does not exist. + |
+The enterprise project does not exist. + |
+Check the enterprise project. + |
+|
Quota management + |
+500 + |
+DNS.2000 + |
+Invalid Quota Manage service endpoint configuration. + |
+Invalid endpoint configuration of the quota management service. + |
+Contact customer service. + |
+
500 + |
+DNS.2001 + |
+An error occurred when the Quota Manage service is called. + |
+An exception occurred when the quota management service is called. + |
+Contact customer service. + |
+|
403 + |
+DNS.2002 + |
+Insufficient domain quota. + |
+Insufficient tenant resource quota. + |
+The number of resources has reached the quota limit. If the limit does not meet your requirements, contact customer service. + |
+
Parameter + |
+Description + |
+
|---|---|
ACTIVE + |
+Normal + |
+
PENDING_CREATE + |
+Creating + |
+
PENDING_DELETE + |
+Deleting + |
+
PENDING_UPDATE + |
+Updating + |
+
FREEZE + |
+Frozen + |
+
PENDING_DISABLE + |
+Disabling + |
+
DISABLE + |
+Disabled + |
+
ERROR + |
+Failed + |
+
Type + |
+Description + |
+
|---|---|
A + |
+Map domains to IPv4 addresses. + |
+
CNAME + |
+Map one domain to another. CNAME record sets are usually used to map multiple domain names to the same host. + |
+
MX + |
+Map domains to email servers. + |
+
AAAA + |
+Map domains to IPv6 addresses. + |
+
TXT + |
+Specify text records. + |
+
SRV + |
+Record servers providing specific services. + |
+
NS + |
+Delegate subdomains to other name servers. + |
+
SOA + |
+Specify the master authoritative DNS server for a domain name. The SOA record set is created by the system and cannot be manually added. + |
+
CAA + |
+Grant certificate issuing permissions to CAs. CAA record sets can be used to prevent unauthorized HTTPS certificate issuing. + |
+
PTR + |
+Map IP addresses to domains. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
self + |
+String + |
+Link to the current resource + |
+
next + |
+String + |
+Link to the next page + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Tag key. The key contains 36 Unicode characters at most and cannot be blank. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
value + |
+String + |
+Tag value. Each value contains 43 Unicode characters at most and can be an empty string. It can contain only digits, letters, hyphens (-), and underscores (_). + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
router_id + |
+String + |
+ID of the associated VPC +You can obtain the VPC ID using the following methods: +
|
+
router_region + |
+String + |
+Region of the VPC +If it is left blank, the region of the project in the token takes effect by default. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resource_type + |
+String + |
+Service that support domain name aliases +The value can be cloudsite or waf (Web Application Firewall). + |
+
resource_domain_name + |
+String + |
+Domain name of the target service + |
+
On the My Credentials page, view project IDs in the project list.
+
In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.
+Date + |
+Description + |
+
|---|---|
2021-01-31 + |
+This issue incorporates the following changes: +
|
+
2019-01-30 + |
+This issue incorporates the following changes: +Added error messages in section Error Code. + |
+
2018-11-30 + |
+This issue incorporates the following changes: +Added the sort_key and sort_dir fields in the URI in the following sections: + + |
+
2018-09-30 + |
+This issue incorporates the following changes: +Added Querying the DNS API Version. + |
+
2018-08-30 + |
+This issue incorporates the following changes: +Added Querying Resources by Tag. +Integrated tag management for global and region-level resources in Tag Management. + |
+
2018-07-30 + |
+This issue incorporates the following changes: +
|
+
2018-06-30 + |
+This issue incorporates the following changes: +Accepted in OTC 3.1. + |
+
2018-06-15 + |
+This issue incorporates the following changes: +Changed the tag character set range, covering the following sections: + + |
+
2018-05-04 + |
+This issue incorporates the following changes: +Added offset in the request URL, covering the following sections: + + |
+
2018-03-30 + |
+This issue incorporates the following changes: +Added the following content: + +Added tag information in the request body and URL, covering the following sections: +
|
+
2018-02-28 + |
+This issue incorporates the following changes: +
|
+
2018-01-31 + |
+This issue incorporates the following changes: +Added section Tag Management. +Added tag error codes in section Error Code. + |
+
2018-01-10 + |
+This issue incorporates the following changes: +Added error codes in section Error Code. + |
+
2017-12-30 + |
+This issue incorporates the following changes: + + |
+
2017-10-30 + |
+This issue incorporates the following changes: +Added the following sections: + +Modified the following sections: +
|
+
2017-09-30 + |
+This issue incorporates the following changes: +Added the following sections: + +Modified the following sections: +
|
+
2017-09-01 + |
+This issue incorporates the following changes: +Supported the multi-project function. +Modified the following sections: +
|
+
2017-06-16 + |
+This issue incorporates the following changes: +Changed the maximum number of resources returned on each page to 500 (value of limit in sections Querying Public Zones, Querying Private Zones, Querying All Record Sets, and Querying All PTR Records). + |
+
2017-04-28 + |
+This issue incorporates the following changes: +Supported private zones. +Added the following sections: + +Modified the following content: +
|
+
2017-01-20 + |
+This issue incorporates the following changes: + + |
+
2016-11-30 + |
+This issue incorporates the following changes: +Added the API to query the version number in section Version Management. + |
+
2016-09-30 + |
+This issue is the first official release. + |
+
| t |