Setting the Record Set Status
Function
This API is used to set the record set status such as disabling and enabling a record set.
Calling Method
For details, see Calling APIs.
URI
PUT /v2.1/recordsets/{recordset_id}/statuses/set
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
recordset_id |
Yes |
String |
Definition Record set ID Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
status |
Yes |
String |
Definition Record set status Range
|
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition The record set ID. Range N/A |
name |
String |
Definition The name of the record set. Range N/A |
description |
String |
Definition The description of the record set. Range The value can contain a maximum of 255 characters. |
zone_id |
String |
Definition The ID of the zone that hosts the record set. Range N/A |
zone_name |
String |
Definition The zone that hosts the record set. Range N/A |
type |
String |
Definition The type of the record set. Range
|
ttl |
Integer |
Definition The TTL of the record set in the local DNS server. It is measured in seconds. Longer TTLs reduce queries but delay updates. Range 1 to 2147483647 |
records |
Array of strings |
Definition The value returned for domain name resolution. Range N/A |
created_at |
String |
Definition The time when the record set was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A |
updated_at |
String |
Definition The time when the record set was last modified. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A |
status |
String |
Definition The status of the record set. Range
|
default |
Boolean |
Definition Identifies whether the record set is created by default. A default record set cannot be deleted. Range N/A |
project_id |
String |
Definition The ID of the project to which the record set belongs. Range N/A |
links |
pageLink object |
Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A |
line |
String |
Definition The resolution line ID. Range N/A |
weight |
Integer |
Definition The weight of the record set. Range 0 to 1000 |
health_check_id |
String |
Definition The health check ID. Range N/A |
alias_target |
alias_target object |
Definition The alias record set. Range N/A |
bundle |
String |
Definition Specification, which is the default specification. This field is reserved. Range N/A |
Parameter |
Type |
Description |
---|---|---|
self |
String |
Definition The link to the current page. Range N/A |
next |
String |
Definition The link to the next page. Range N/A |
Parameter |
Type |
Description |
---|---|---|
resource_type |
String |
Definition Services that support domain name aliases Constraints N/A Range
Default Value N/A |
resource_domain_name |
String |
Definition Domain name of the target service Constraints N/A Range N/A Default Value N/A |
Example Requests
Disabling a record set
PUT https://{endpoint}/v2.1/recordsets/{recordset_id}/statuses/set { "status" : "DISABLE" }
Example Responses
Status code: 202
Request accepted
{ "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" : "DISABLE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007" }, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "created_at" : "2017-11-09T11:13:17.827", "updated_at" : "2017-11-10T12:03:18.827", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null }
SDK Sample Code
The SDK sample code is as follows.
Disabling a record set
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 |
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.*; public class SetRecordSetsStatusSolution { 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(); SetRecordSetsStatusRequest request = new SetRecordSetsStatusRequest(); request.withRecordsetId("{recordset_id}"); SetRecordSetsStatusRequestBody body = new SetRecordSetsStatusRequestBody(); body.withStatus("DISABLE"); request.withBody(body); try { SetRecordSetsStatusResponse response = client.setRecordSetsStatus(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 a record set
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 |
# 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 = SetRecordSetsStatusRequest() request.recordset_id = "{recordset_id}" request.body = SetRecordSetsStatusRequestBody( status="DISABLE" ) response = client.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 a record set
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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dns.NewDnsClient( dns.DnsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.SetRecordSetsStatusRequest{} request.RecordsetId = "{recordset_id}" request.Body = &model.SetRecordSetsStatusRequestBody{ Status: "DISABLE", } response, err := client.SetRecordSetsStatus(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 |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank 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