Creating a Domain Name
Function
This API is used to create a domain name.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/aad/external/domains
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API. The token is the value of X-Subject-Token in the response header. |
|
Content-Type |
Yes |
String |
Content-Type |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain_name |
Yes |
String |
Domain name |
|
enterprise_project_id |
Yes |
String |
Enterprise project ID. It must be the same as that of the AAD instance. You can view the enterprise project ID in Huawei Cloud EPS. The default enterprise project ID is 0. |
|
vips |
No |
Array of strings |
IP addresses of AAD instances. IP addresses of AAD instances must belong to the same enterprise project. |
|
real_server_type |
Yes |
Integer |
Origin server type. 0: IP address of the origin server; 1: domain name of the origin server |
|
port_http |
No |
Array of integers |
HTTP port. This parameter and port_https cannot be both empty. You can view the HTTP ports supported by AAD on the console. |
|
port_https |
No |
Array of integers |
HTTPS port. This parameter and port_http cannot be both empty. You can view the HTTPS ports supported by AAD on the console. |
|
real_server |
Yes |
String |
Origin server IP address or domain name. |
|
instance_ids |
No |
Array of strings |
Instance ID list. This parameter and vips cannot be both empty in partner scenarios. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
cname |
String |
CNAME address provided by AAD. |
|
domainId |
String |
Domain name ID. |
Example Requests
None
Example Responses
Status code: 200
OK
{
"domainId" : "81c8xxxxxxxxxxxxxxxx11c9",
"cname" : "29xxxxxxxxxxxx1e.huaweisafedns.cn"
}
SDK Sample Code
The SDK sample code is as follows.
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.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.aad.v1.region.AadRegion; import com.huaweicloud.sdk.aad.v1.*; import com.huaweicloud.sdk.aad.v1.model.*; public class CreateDomainSolution { 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"); String domainId = ""; ICredential auth = new GlobalCredentials() .withDomainId(domainId) .withAk(ak) .withSk(sk); AadClient client = AadClient.newBuilder() .withCredential(auth) .withRegion(AadRegion.valueOf("<YOUR REGION>")) .build(); CreateDomainRequest request = new CreateDomainRequest(); HostBody body = new HostBody(); request.withBody(body); try { CreateDomainResponse response = client.createDomain(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkaad.v1.region.aad_region import AadRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaad.v1 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"] domainId = "" credentials = GlobalCredentials(ak, sk, domainId) client = AadClient.new_builder() \ .with_credentials(credentials) \ .with_region(AadRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateDomainRequest() request.body = HostBody( ) response = client.create_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) |
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/global" aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1/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") domainId := "" auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithDomainId(domainId). Build() client := aad.NewAadClient( aad.AadClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateDomainRequest{} request.Body = &model.HostBody{ } response, err := client.CreateDomain(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 |
|---|---|
|
200 |
OK |
|
400 |
Error |
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