Disabling CDN for a Domain Name

Function

This API is used to disable CDN for a domain name.

Calling Method

For details, see Calling APIs.

URI

PUT /v1.0/cdn/domains/{domain_id}/disable

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Domain name ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	ID of the enterprise project that the domain name to be modified belongs to. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. This parameter is mandatory when you use an IAM user to call this API. Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
domain	DomainsWithPort object	Domain name details.

**Table 5** DomainsWithPort
Parameter	Type	Description
id	String	Domain name ID.
domain_name	String	Domain name.
business_type	String	Service type of the domain name. Possible values: web (website acceleration), download (file download acceleration), video (on-demand service acceleration), and wholeSite (whole site acceleration).
user_domain_id	String	Domain ID of the domain name's owner.
domain_status	String	Domain name status. Possible values: online: CDN has been enabled for this domain name. offline: CDN has been disabled for this domain name. configuring: The domain name configuration is in progress. configure_failed: The configuration fails. checking: The domain is being reviewed. check_failed: The domain name fails the review. deleting: The domain name is being deleted.
cname	String	CNAME record of the domain name.
sources	Array of SourceWithPort objects	Origin server settings.
domain_origin_host	DomainOriginHost object	Host header settings for origin pull.
https_status	Integer	Whether HTTPS is enabled for acceleration. 0: HTTPS is disabled. 1: HTTPS is enabled and the origin protocol is same as the user request. 2: HTTPS is enabled and the origin protocol is HTTP. 3: HTTPS is enabled and the origin protocol is HTTPS.
create_time	Long	Time when the domain name was created. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).
modify_time	Long	Time when the domain name was modified. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).
disabled	Integer	Whether the domain name is banned. Possible values: 0 (not banned) and 1 (banned).
locked	Integer	Whether the domain name is locked. Possible values: 0 (not locked) and 1 (locked).
auto_refresh_preheat	Integer	Whether automatic cache purge and prefetch are enabled. Possible values: 0 (disabled) and 1 (enabled).
service_area	String	Service area of the CDN service. Possible values: mainland_china (Chinese mainland), outside_mainland_china (outside the Chinese mainland), and global (global).
range_status	String	Whether range requests are supported. Possible values: off (not supported) and on (supported).
follow_status	String	Status of redirect from origin. Possible values: off (disabled) and on (enabled).
origin_status	String	Origin pull status. Possible values: off (disabled) and on (enabled).
banned_reason	String	Reason for banning the domain name. 1: This domain name contains inappropriate content. 2: The MIIT license of this domain name has expired. 3: This domain name is attacked. 150: This domain name contains pornographic content. 151: This domain name contains sensitive political content. 152: This domain name contains violent content. 153: This domain name contains gambling content.
locked_reason	String	Reason for locking the domain name.
enterprise_project_id	String	ID of the enterprise project to which the resource belongs. This parameter is valid only when the enterprise project function is enabled. If this parameter is not specified, the default project is used. This parameter is mandatory when you use an IAM user to call this API. Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).

**Table 6** SourceWithPort
Parameter	Type	Description
domain_id	String	Domain name ID.
ip_or_domain	String	Non-intranet IP address or domain name of the origin server.
origin_type	String	Origin server type. Possible values: ipaddr (IP address), domain (domain name), and obs_bucket (OBS bucket).
obs_bucket_type	String	OBS bucket type. private: private bucket (Users except those authorized by the bucket ACL do not have the permission to access the bucket.) public: public bucket (Any user can read objects in the bucket.)
active_standby	Integer	Whether the origin server is primary or standby. Possible values: 1 (primary) and 0 (standby).
enable_obs_web_hosting	Integer	Whether static website hosting is enabled for an OBS bucket. Possible values: 0 (disabled) and 1 (enabled). This parameter is passed only when origin_type is set to obs_bucket.
http_port	Integer	HTTP port. Default value: 80.
https_port	Integer	HTTPS port. Default value: 443.

**Table 7** DomainOriginHost
Parameter	Type	Description
domain_id	String	Domain name ID.
origin_host_type	String	Host type. Possible values: accelerate (acceleration domain name) and customize (custom domain name).
customize_domain	String	Domain name of the host. Host for pull from the primary origin server. If the acceleration domain name has multiple primary origin servers and each origin server has a host, CDN pulls content from the host of the first primary origin server in the origin server lists.

Example Requests

PUT https://cdn.myhuaweicloud.com/v1.0/cdn/domains/ff8080***********************722/disable?enterprise_project_id=0

Example Responses

Status code: 200

{
  "domain" : {
    "sources" : [ {
      "domain_id" : "ff8080***********************722",
      "origin_type" : "ipaddr",
      "ip_or_domain" : "0.0.0.0",
      "active_standby" : 1,
      "http_port" : 80,
      "https_port" : 443
    } ],
    "cname" : "www.example1.example2.0002.example3.com.c.example4.com",
    "id" : "ff8080***********************722",
    "user_domain_id" : "6e358***********************a441",
    "domain_name" : "www.example1.example2.0002.example3.com",
    "business_type" : "web",
    "service_area" : "mainland_china",
    "domain_status" : "configuring",
    "https_status" : 0,
    "create_time" : 1532403213673,
    "modify_time" : 1532403548714,
    "domain_origin_host" : {
      "domain_id" : "ff8080***********************722",
      "origin_host_type" : "accelerate",
      "customize_domain" : "www.example1.example2.0002.example3.com"
    },
    "disabled" : 0,
    "locked" : 0,
    "range_status" : "off",
    "follow_status" : "off",
    "origin_status" : "off",
    "auto_refresh_preheat" : 0
  }
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.cdn.v2.region.CdnRegion;
import com.huaweicloud.sdk.cdn.v2.*;
import com.huaweicloud.sdk.cdn.v2.model.*;


public class DisableDomainSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CdnClient client = CdnClient.newBuilder()
                .withCredential(auth)
                .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                .build();
        DisableDomainRequest request = new DisableDomainRequest();
        request.withDomainId("{domain_id}");
        try {
            DisableDomainResponse response = client.disableDomain(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcdn.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 = GlobalCredentials(ak, sk)

    client = CdnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CdnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DisableDomainRequest()
        request.domain_id = "{domain_id}"
        response = client.disable_domain(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cdn.NewCdnClient(
        cdn.CdnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DisableDomainRequest{}
	request.DomainId = "{domain_id}"
	response, err := client.DisableDomain(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     