更新时间:2025-04-27 GMT+08:00
分享

批量设置域名状态

功能介绍

批量设置域名状态。

响应结果中只包含本次实际更新的域名。

支持公网域名、内网域名。

调用方法

请参见如何调用API

URI

PUT /v2.1/zones/statuses

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

status

String

待设置域名状态,支持DISABLE或ENABLE。

zone_ids

Array of strings

待设置域名ID列表。

最多支持50个。

响应参数

状态码:202

表2 响应Body参数

参数

参数类型

描述

links

Link object

指向当前资源的链接。

zones

Array of ZoneData objects

设置域名的列表响应。

metadata

metadata object

返回满足过滤条件的资源总数。

表3 ZoneData

参数

参数类型

描述

id

String

域名的ID,UUID形式的一个资源标识。

name

String

域名。

description

String

对域名的描述信息。

email

String

管理该域名的管理员邮箱,用于生成该域名的SOA记录。

ttl

Integer

该域名下SOA记录中的ttl值。

serial

Integer

该域名下SOA记录中用于标识域名文件变更的序列值,用于主从节点同步。

masters

Array of strings

主从模式中,从DNS服务器获取DNS信息。

status

String

资源状态。

pool_id

String

托管该域名的pool,由系统分配。

project_id

String

域名所属的项目ID。

zone_type

String

域名类型,取值public或private。

created_at

String

创建时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

updated_at

String

更新时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

record_num

Integer

该域名下的记录集个数。

links

Link object

指向当前资源的链接。

表5 metadata

参数

参数类型

描述

total_count

Integer

满足查询条件的资源总数,不受分页(即limit、offset参数)影响。

状态码:400

表6 响应Body参数

参数

参数类型

描述

code

String

错误码。

message

String

错误描述。

状态码:500

表7 响应Body参数

参数

参数类型

描述

code

String

错误码。

message

String

错误描述。

请求示例

批量设置域名的状态为暂停解析。

PUT https://{endpoint}/v2.1/zones/statuses

{
  "status" : "DISABLE",
  "zone_ids" : [ "2c9eb155587194ec01587224c9f90149", "2c9eb155587194ec01587224c9f90150" ]
}

响应示例

状态码:202

批量设置域名状态响应。

{
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/statuses"
  },
  "zones" : [ {
    "id" : "2c9eb155587194ec01587224c9f90149",
    "name" : "example.com.",
    "description" : "This is an example zone.",
    "email" : "xx@example.com",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "DISABLE",
    "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,
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
    }
  }, {
    "id" : "2c9eb155587228570158722996c50001",
    "name" : "example.org.",
    "description" : "This is an example zone.",
    "email" : "xx@example.org",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "DISABLE",
    "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,
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001"
    }
  } ],
  "metadata" : {
    "total_count" : 2
  }
}

SDK代码示例

SDK代码示例如下。

批量设置域名的状态为暂停解析。

 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 BatchSetZonesStatusSolution {

    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();
        BatchSetZonesStatusRequest request = new BatchSetZonesStatusRequest();
        BatchSetZonesStatusRequestBody body = new BatchSetZonesStatusRequestBody();
        List<String> listbodyZoneIds = new ArrayList<>();
        listbodyZoneIds.add("2c9eb155587194ec01587224c9f90149");
        listbodyZoneIds.add("2c9eb155587194ec01587224c9f90150");
        body.withZoneIds(listbodyZoneIds);
        body.withStatus("DISABLE");
        request.withBody(body);
        try {
            BatchSetZonesStatusResponse response = client.batchSetZonesStatus(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());
        }
    }
}

批量设置域名的状态为暂停解析。

 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 = BatchSetZonesStatusRequest()
        listZoneIdsbody = [
            "2c9eb155587194ec01587224c9f90149",
            "2c9eb155587194ec01587224c9f90150"
        ]
        request.body = BatchSetZonesStatusRequestBody(
            zone_ids=listZoneIdsbody,
            status="DISABLE"
        )
        response = client.batch_set_zones_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)

批量设置域名的状态为暂停解析。

 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
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.BatchSetZonesStatusRequest{}
	var listZoneIdsbody = []string{
        "2c9eb155587194ec01587224c9f90149",
	    "2c9eb155587194ec01587224c9f90150",
    }
	request.Body = &model.BatchSetZonesStatusRequestBody{
		ZoneIds: listZoneIdsbody,
		Status: "DISABLE",
	}
	response, err := client.BatchSetZonesStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

202

批量设置域名状态响应。

400

接口错误响应。

500

接口错误响应。

错误码

请参见错误码

相关文档