Modifying the Domain Name Configuration
Function
This API is used to modify domain name configurations.
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, no identity policy-based permission required for calling this API.
URI
PUT /v2/aad/domains/{domain_id}/config
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| domain_id | Yes | String | Domain name ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | token |
| Content-Type | Yes | String | Content-Type |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| real_server_type | Yes | Integer | Origin server type. 0: origin server IP address. 1: origin server domain name. |
| real_server | Yes | String | Origin server IP address or domain name. |
| port_http | No | Array of integers | HTTP port. This parameter and port_https cannot be both empty. You can use the ListDomainPort interface to query the HTTP ports supported by AAD. |
| port_https | No | Array of integers | HTTPS port. This parameter and port_http cannot be both empty. You can use the ListDomainPort interface to query the HTTPS ports supported by AAD. |
| overseas_type | No | String | Protected area. 0: Chinese mainland; 1: outside the Chinese mainland. |
| cert_name | No | String | Certificate name |
Response Parameters
Status code: 200
None
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_description | String | Error description. |
Example Requests
Change the origin server type to IP address and the origin server to 1.x.x.1.
PUT https://{endpoint}/v2/aad/domains/579b0ccd-ac06-xxxx-xxxx-fa163eaa216e/config
{
"real_server_type" : 0,
"real_server" : "1.x.x.2",
"port_http" : [ 80 ],
"overseas_type" : "0",
"cert_name" : "123"
} Example Responses
Status code: 200
{ } SDK Sample Code
The SDK sample code is as follows.
Change the origin server type to IP address and the origin server to 1.x.x.1.
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 56 57 | 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.v2.region.AadRegion; import com.huaweicloud.sdk.aad.v2.*; import com.huaweicloud.sdk.aad.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateDomainConfigSolution { 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); AadClient client = AadClient.newBuilder() .withCredential(auth) .withRegion(AadRegion.valueOf("<YOUR REGION>")) .build(); UpdateDomainConfigRequest request = new UpdateDomainConfigRequest(); request.withDomainId("{domain_id}"); UpdateDomainConfigRequestBody body = new UpdateDomainConfigRequestBody(); List<Integer> listbodyPortHttp = new ArrayList<>(); listbodyPortHttp.add(80); body.withCertName("123"); body.withOverseasType("0"); body.withPortHttp(listbodyPortHttp); body.withRealServer("1.x.x.2"); body.withRealServerType(UpdateDomainConfigRequestBody.RealServerTypeEnum.NUMBER_0); request.withBody(body); try { UpdateDomainConfigResponse response = client.updateDomainConfig(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()); } } } |
Change the origin server type to IP address and the origin server to 1.x.x.1.
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkaad.v2.region.aad_region import AadRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaad.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 = AadClient.new_builder() \ .with_credentials(credentials) \ .with_region(AadRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateDomainConfigRequest() request.domain_id = "{domain_id}" listPortHttpbody = [ 80 ] request.body = UpdateDomainConfigRequestBody( cert_name="123", overseas_type="0", port_http=listPortHttpbody, real_server="1.x.x.2", real_server_type=0 ) response = client.update_domain_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Change the origin server type to IP address and the origin server to 1.x.x.1.
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 56 57 58 59 60 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := aad.AadClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := aad.NewAadClient(hcClient) request := &model.UpdateDomainConfigRequest{} request.DomainId = "{domain_id}" var listPortHttpbody = []int32{ int32(80), } certNameUpdateDomainConfigRequestBody:= "123" overseasTypeUpdateDomainConfigRequestBody:= "0" request.Body = &model.UpdateDomainConfigRequestBody{ CertName: &certNameUpdateDomainConfigRequestBody, OverseasType: &overseasTypeUpdateDomainConfigRequestBody, PortHttp: &listPortHttpbody, RealServer: "1.x.x.2", RealServerType: model.GetUpdateDomainConfigRequestBodyRealServerTypeEnum().E_0, } response, err := client.UpdateDomainConfig(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 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