Last updated: 2020-09-10 17:37:01

1. API Description

Domain name for API request:

Get scheduling domain name list

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 parameter. The value used for this API: DescribeSchedulingDomainList.
Version Yes String Common parameter. The value used for this API: 2018-07-09.
Region No String Common parameter. This parameter is not required for this API.
Limit Yes Integer Number of items in a page. Returned results are not paged if you enter '0'.
Offset Yes Integer Starting offset of the page. Value: (number of pages - 1) * items per page
Domain No String (Optional) Filter by specific domain name

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of scheduling domain names
DomainList Array of SchedulingDomain List of scheduling domain names
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the scheduling domain name list

Input Example
&<common request parameters>

Output Example

  "Response": {
    "RequestId": "8466d9e1-70a9-4575-8e02-df15bd50bc49",
    "Total": 1,
    "DomainList": [
        "Domain": "",
        "BGPIpList": [],
        "CTCCIpList": [],
        "CUCCIpList": [],
        "CMCCIpList": [],
        "OverseaIpList": [],
        "Method": "priority",
        "CreateTime": "2019-08-21 12:32:12",
        "Status": 1,
        "ModifyTime": "2019-08-21 12:32:45"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


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
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
InternalError An internal error occurred.
InvalidParameter A parameter error occurred.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback