Creating an Authorization Task for a Public Subdomain
Function
When you create a subdomain, the system displays a message indicating that the domain conflicts with that of another tenant and you need to add a TXT record for verification. You can call the API to generate the TXT record verification information for the subdomain.
Public zones are global resources. You need to select the AP-Singapore (ap-southeast-3) region.
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, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
dns:zone:createAuthorizeTxtRecord
Write
-
-
-
-
URI
POST /v2/authorize-txtrecord
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 |
|---|---|---|---|
|
zone_name |
Yes |
String |
Definition Subdomain to be created. Constraints N/A Range N/A Default value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Definition Authorization request ID. Range N/A |
|
zone_name |
String |
Definition Subdomain to be created. Range N/A |
|
record |
RecordInfo object |
Definition Record set information. Range N/A |
|
status |
String |
Definition Authorization status. Range
|
|
second_level_zone_name |
String |
Definition Second-level domain to which the subdomain belongs. Range N/A |
|
created_at |
String |
Definition Creation time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A |
|
updated_at |
String |
Definition Update time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
host |
String |
Definition Name of the record set. Range N/A |
|
value |
String |
Definition Value of the record set. Range N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code Range N/A |
|
message |
String |
Definition Error description Range N/A |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code Range N/A |
|
message |
String |
Definition Error description Range N/A |
Example Requests
Request for creating an authorization task for a public subdomain
POST https://{endpoint}/v2/authorize-txtrecord
{
"zone_name" : "www.example.com"
}
Example Responses
Status code: 200
Response for creating an authorization task for a public subdomain
{
"id" : "a86dba5800434cc6a1bb69d5e86f3ca3",
"zone_name" : "www.example.com.",
"second_level_zone_name" : "example.com.",
"record" : {
"host" : "authorize-aa6c2459738d403daf37a3b206197ea1",
"value" : "a86dba5800434cc6a1bb69d5e86f3ca3"
},
"status" : "CREATED",
"created_at" : "2016-11-17T11:56:03.439",
"updated_at" : "2016-11-17T11:56:03.439"
}
SDK Sample Code
The SDK sample code is as follows.
Request for creating an authorization task for a public subdomain
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 |
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 CreateAuthorizeTxtRecordSolution { 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(); CreateAuthorizeTxtRecordRequest request = new CreateAuthorizeTxtRecordRequest(); CreateAuthorizeTxtRecordRequestBody body = new CreateAuthorizeTxtRecordRequestBody(); body.withZoneName("www.example.com"); request.withBody(body); try { CreateAuthorizeTxtRecordResponse response = client.createAuthorizeTxtRecord(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()); } } } |
Request for creating an authorization task for a public subdomain
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 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 = CreateAuthorizeTxtRecordRequest() request.body = CreateAuthorizeTxtRecordRequestBody( zone_name="www.example.com" ) response = client.create_authorize_txt_record(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Request for creating an authorization task for a public subdomain
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 |
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.CreateAuthorizeTxtRecordRequest{} request.Body = &model.CreateAuthorizeTxtRecordRequestBody{ ZoneName: "www.example.com", } response, err := client.CreateAuthorizeTxtRecord(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 |
Response for creating an authorization task for a public subdomain |
|
400 |
Error response. |
|
500 |
Error response. |
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