Batch Setting the Status of Record Sets
Function
This API is used to set the status of record sets in batches.
The response contains only the record sets that are updated.
Record sets of both public and private zones are supported.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
PUT /v2.1/recordsets/statuses
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| status | Yes | String | Definition Status of the record set to be set Constraints N/A Range Default Value N/A |
| recordset_ids | Yes | Array of strings | Definition IDs of record sets you want to set statuses for. This field is a string array. Each element is a record set ID. You can obtain the IDs by calling the API (ListRecordSetsWithLine) for querying the record sets of a tenant. Constraints You can specify a maximum of 50 IDs. |
Response Parameters
Status code: 202
| Parameter | Type | Description |
|---|---|---|
| links | Link object | Definition Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page. |
| recordsets | Array of RecordsetData objects | Definition Record set list. This field is an array. Each element contains fields such as the record set ID, name, type, TTL, and record value list. |
| metadata | metadata object | Definition The number of resources that meet filter conditions. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Record set ID Range N/A |
| name | String | Definition Record set name Range N/A |
| description | String | Definition The description of the record set. Range The value can contain a maximum of 255 characters. |
| type | String | Definition Record set type. Range
|
| ttl | Integer | Definition Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update will be applied. Range 1 to 2147483647 |
| records | Array of strings | Definition Record set value. This field is a string array. Each element is the value of a record set. |
| status | String | Definition The status of the record set. Range |
| zone_id | String | Definition Zone ID of the record set Range N/A |
| zone_name | String | Definition The zone that hosts the record set. Range N/A |
| line | String | Definition Resolution line ID Range N/A |
| alias_target | alias_target object | Definition Domain name alias. |
| created_at | String | Definition Creation time. The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000. Range N/A |
| updated_at | String | Definition Update time. The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000. Range N/A |
| health_check_id | String | Definition Health check ID Range N/A |
| default | Boolean | Definition Whether the record set is created by default. A default record set cannot be deleted. Range |
| project_id | String | Definition ID of the project to which the record set belongs Range N/A |
| links | Link object | Definition Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page. |
| weight | Integer | Definition Weight of the record set Range 0 to 1000 |
| Parameter | Type | Description |
|---|---|---|
| resource_type | String | Definition Service that supports domain name aliases. Range |
| resource_domain_name | String | Definition Domain name of the target service. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| self | String | Definition Link to the current resource. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| total_count | Integer | Definition Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| code | String | Definition Error code Range N/A |
| message | String | Definition Error description Range N/A |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| code | String | Definition Error code Range N/A |
| message | String | Definition Error description Range N/A |
Example Requests
Disabling record sets
PUT https://{Endpoint}/v2.1/recordsets/statuses
{
"status" : "DISABLE",
"recordset_ids" : [ "2c9eb155587228570158722b6ac30007", "2c9eb155587228570158722b6ac30008" ]
} Example Responses
Status code: 202
{
"links" : {
"self" : "https://{Endpoint}/v2.1/recordsets/statuses"
},
"recordsets" : [ {
"id" : "2c9eb155587228570158722b6ac30007",
"name" : "www.example.com.",
"description" : "This is an example record set.",
"type" : "A",
"ttl" : 300,
"records" : [ "192.168.10.2", "192.168.10.1" ],
"status" : "DISABLE",
"zone_id" : "2c9eb155587194ec01587224c9f90149",
"zone_name" : "example.com.",
"line" : null,
"alias_target" : null,
"created_at" : "2016-11-17T12:03:17.827",
"updated_at" : "2016-11-17T12:56:03.827",
"health_check_id" : null,
"default" : false,
"project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
"links" : {
"self" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
},
"weight" : null
}, {
"id" : "2c9eb155587228570158722b6ac30008",
"name" : "www.example.com.",
"description" : "This is an example record set.",
"type" : "A",
"ttl" : 300,
"records" : [ "192.168.10.2", "192.168.10.1" ],
"status" : "DISABLE",
"zone_id" : "2c9eb155587194ec01587224c9f90149",
"zone_name" : "example.com.",
"line" : null,
"alias_target" : null,
"created_at" : "2016-11-17T12:03:17.827",
"updated_at" : "2016-11-17T12:56:03.827",
"health_check_id" : null,
"default" : false,
"project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
"links" : {
"self" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30008"
},
"weight" : null
} ],
"metadata" : {
"total_count" : 2
}
} SDK Sample Code
The SDK sample code is as follows.
Disabling record sets
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dns.v2.region.DnsRegion; import com.huaweicloud.sdk.dns.v2.*; import com.huaweicloud.sdk.dns.v2.model.*; import java.util.List; import java.util.ArrayList; public class BatchSetRecordSetsStatusSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DnsClient client = DnsClient.newBuilder() .withCredential(auth) .withRegion(DnsRegion.valueOf("<YOUR REGION>")) .build(); BatchSetRecordSetsStatusRequest request = new BatchSetRecordSetsStatusRequest(); BatchSetRecordSetsStatusRequestBody body = new BatchSetRecordSetsStatusRequestBody(); List<String> listbodyRecordsetIds = new ArrayList<>(); listbodyRecordsetIds.add("2c9eb155587228570158722b6ac30007"); listbodyRecordsetIds.add("2c9eb155587228570158722b6ac30008"); body.withRecordsetIds(listbodyRecordsetIds); body.withStatus("DISABLE"); request.withBody(body); try { BatchSetRecordSetsStatusResponse response = client.batchSetRecordSetsStatus(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Disabling record sets
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdns.v2.region.dns_region import DnsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdns.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = DnsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DnsRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchSetRecordSetsStatusRequest() listRecordsetIdsbody = [ "2c9eb155587228570158722b6ac30007", "2c9eb155587228570158722b6ac30008" ] request.body = BatchSetRecordSetsStatusRequestBody( recordset_ids=listRecordsetIdsbody, status="DISABLE" ) response = client.batch_set_record_sets_status(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Disabling record sets
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dns.DnsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dns.NewDnsClient(hcClient) request := &model.BatchSetRecordSetsStatusRequest{} var listRecordsetIdsbody = []string{ "2c9eb155587228570158722b6ac30007", "2c9eb155587228570158722b6ac30008", } request.Body = &model.BatchSetRecordSetsStatusRequestBody{ RecordsetIds: listRecordsetIdsbody, Status: "DISABLE", } response, err := client.BatchSetRecordSetsStatus(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 202 | Request accepted |
| 400 | Error response |
| 500 | Error response |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot