ListDomains--镜像仓库-火山引擎

文档中心

立即注册

导航

ListDomains

最近更新时间：2024.09.27 11:28:29首次发布时间：2022.06.14 21:29:04

查询镜像仓库实例域名。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListDomains&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时，除了以下请求参数外，还需传入公共请求参数。公共请求参数说明，请参见火山引擎公共参数文档。

参数	类型	是否必选	示例值	描述
Action	String	是	ListDomains	接口名称。当前 API 的名称为 `ListDomains`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Registry	String	是	registrya	要查询域名的镜像仓库实例名称。
PageSize	Long	否	10	单页展示的域名信息数量，默认为 10 个，取值范围为 [1,100] 的整数。
PageNumber	Long	否	1	开始显示返回结果的页码，从 1 开始，默认为 1，取值范围为 [1,2147483647] 的整数。

请求示例

POST https://open.volcengineapi.com?Action=ListDomains&Version=2022-05-12
{
    "Registry": "registrya"
}

返回参数

参数	类型	示例值	描述
Registry	String	registrya	镜像仓库实例名称。
TotalCount	Long	1	域名总数。
PageNumber	Long	1	当前页码。
PageSize	Long	10	单页显示的域名信息条数。
Items	Array of Domain	[{"Domain": "aaa.com", "Type": "System", "CreateTime": "2022-05-20T13:00:55Z"}]	镜像仓库实例域名列表。

Domain

参数	类型	示例值	描述
Domain	String	helm-cr-cn-beijing.cr.volces.com	镜像仓库域名：体验版实例域名：存量实例：`cr-cn-beijing.volces.com` 新建或升级后的实例：`[实例名]-[地域].cr.volces.com` 标准版实例域名：`[实例名]-[地域].cr.volces.com`
Type	String	System	域名类型： System ：系统提供的域名。 Volcengine：火山引擎域名。 ThirdParty：第三方域名。
CreateTime	String	2022-05-20T13:00:55Z	域名创建的时间，使用 RFC 3339 格式。
Default	Boolean	true	该域名是否为镜像仓库系统域名。 true：默认域名。 false：不是默认域名。

返回示例

{
    "ResponseMetadata" : {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "ListDomains",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing",
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "Registry": "registrya",
        "Items": [
            {
                "Domain": "xx.com",
                "Type": "System"
            }
        ]
    }
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.RegistryStatus	The action has been denied due to wrong status %s.	当前实例状态下不允许执行指定操作，请等待状态转换后重试。