tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDomainPurview

Last updated: 2023-03-20 11:02:13

1. API Description

Domain name for API request: dnspod.tencentcloudapi.com.

This API is used to get the permissions of a domain.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeDomainPurview.
Version Yes String Common Params. The value used for this API: 2021-03-23.
Region No String Common Params. This parameter is not required for this API.
Domain Yes String Domain
DomainId No Integer The domain ID. DomainId takes priority over Domain. If DomainId is passed in, Domain is ignored. You can view all Domain and DomainId values via the DescribeDomainList API.

3. Output Parameters

Parameter Name Type Description
PurviewList Array of PurviewInfo Permission list of the domain
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the permissions of a domain

This example shows you how to get the permissions of a domain.

Input Example

POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainPurview
<Common request parameters>

{
    "Domain": "dnspod.site",
    "DomainId": 62
}

Output Example

{
    "Response": {
        "RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166",
        "PurviewList": [
            {
                "Name": "URL Forward",
                "Value": "10"
            },
            {
                "Name": "NS record count",
                "Value": "1999"
            },
            {
                "Name": "AAAA record count",
                "Value": "1999"
            },
            {
                "Name": "SRV record count",
                "Value": "1999"
            },
            {
                "Name": "domain alias count",
                "Value": "10"
            },
            {
                "Name": "max domain lock days",
                "Value": "365"
            },
            {
                "Name": "max domain share count",
                "Value": "1000"
            },
            {
                "Name": "max sub domain level",
                "Value": "12"
            },
            {
                "Name": "max Spread Record level",
                "Value": "10"
            },
            {
                "Name": "max DNS balance count",
                "Value": "60"
            },
            {
                "Name": "min TTL value",
                "Value": "1"
            },
            {
                "Name": "enable mix Spread Reserved",
                "Value": "yes"
            },
            {
                "Name": "enhanced split zone type",
                "Value": "yes"
            },
            {
                "Name": "split zone type by province",
                "Value": "yes"
            },
            {
                "Name": "split zone type by continent",
                "Value": "yes"
            }
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.LoginAreaNotAllowed The request was rejected due to an unusual login location of your account.
FailedOperation.LoginFailed Login failed. Check whether the account and password are correct.
FailedOperation.UnknowError The operation has no response. Try again later.
InvalidParameter.DomainIdInvalid The domain number is incorrect.
InvalidParameter.DomainInvalid The domain is incorrect. Enter a top-level domain such as dnspod.cn.
InvalidParameter.DomainIsAliaser This domain is an alias of another domain.
InvalidParameter.LoginTokenIdError The token ID is incorrect.
InvalidParameter.LoginTokenNotExists The token passed in does not exist.
InvalidParameter.LoginTokenValidateFailed Failed to verify the token.
InvalidParameter.RequestIpLimited Your IP is invalid, so the request was rejected.
InvalidParameter.UnrealNameUser Your account identity has not been verified. Complete identity verification first before performing this operation.
InvalidParameter.UserNotExists The user does not exist.
InvalidParameterValue.DomainNotExists The current domain is incorrect. Return to the previous step and try again.
InvalidParameterValue.UserIdInvalid The user number is incorrect.
LimitExceeded.FailedLoginLimitExceeded Your account has been banned by the system due to excessive failed login attempts.
OperationDenied.DomainOwnerAllowedOnly Only the domain owner can perform this operation.
OperationDenied.NoPermissionToOperateDomain You have no permission to perform operations on the current domain. Return to the domain list.
OperationDenied.NotAgent Your are not a proxy user.
OperationDenied.NotManagedUser The user is not under your account.
RequestLimitExceeded.RequestLimitExceeded The number of API requests exceeds the limit.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy