查询域名列表--全站加速-火山引擎

文档中心

立即注册

导航

查询域名列表

最近更新时间：2023.03.15 10:45:10首次发布时间：2023.03.06 21:20:26

API说明

API名称：DescribeUserDomains 。
API域名：open.volcengineapi.com。
API描述：查询域名列表。

URI参数

公共参数

Action和Version需要放在请求 URL 后方参数中。

参数名称	是否必选	参数类型	参数说明
Action	是	String	API 名称，该参数的取值是 DescribeUserDomains 。
Version	是	String	API 版本，该参数的取值是 2023-01-01 。

注意

DescribeUserDomains 公共参数的 Version为 2023-01-01 。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数名称	是否必选	参数类型	参数说明	示例值
PageNum	是	Integer	页码，默认为1，取值范围：1~100000 。	`1`
PageSize	是	Integer	分页大小，默认为20，取值范围：1~1000 。	`20`
ProjectName	否	[ ]String	查询在这些项目组下的用户域名，不填时默认选择全部项目组。	`test`

响应正文

参数名称	参数类型	参数说明	示例
AllDomainNum	Integer	当前账号下的全部加速域名数量。	`84`
OnlineDomainNum	Integer	当前账号下状态为已启用的加速域名数量。	`73`
Domains	DomainInfo	加速域名信息。	`-`
PageNum	Integer	输入的页码。	`1`
PageSize	Integer	输入的分页大小。	`20`

调用示例

请求示例

POST https://open.volcengineapi.com/?Version=2023-01-01&Action=DescribeUserDomains&<其他公共请求参数>
{ 
	"PageNum": 1, 
	"PageSize": 1, 
	"ProjectName": ["TEST"] 
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230307*****63637A779A700EB16FAF2",
        "Action": "DescribeUserDomains",
        "Version": "2023-01-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "AllDomainNum": 2,
        "OnlineDomainNum": 2,
        "Domains": [
            {
                "Domain": "test3.snssdk.com",
                "Status": "Started",
                "Scope": "domestic"
            }
        ],
        "PageNum": 1,
        "PageSize": 1
    }
}