API 文档

查询命名空间信息

最近更新时间:2020-06-16 08:56:09

1. 接口描述

接口请求域名: tcr.tencentcloudapi.com 。

查询命名空间列表或指定命名空间信息

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tcr.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNamespaces。
Version String 公共参数,本接口取值:2019-09-24。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, na-siliconvalley
RegistryId String 实例Id
NamespaceName String 指定命名空间,不填写默认查询所有命名空间
Limit Integer 每页个数
Offset Integer 页偏移

3. 输出参数

参数名称 类型 描述
NamespaceList Array of TcrNamespaceInfo 命名空间列表信息
TotalCount Integer 总个数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询命名空间信息

查询实例内所有的命名空间信息

输入示例

https://tcr.tencentcloudapi.com/?Action=DescribeNamespaces
&RegistryId=tcr-f7g1ir99
&Limit=20&Offset=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "d92365c7-3484-4d52-8add-93f682e127bd",
    "NamespaceList": [
      {
        "Name": "mytest1",
        "CreationTime": "2020-02-27T00:49:22+08:00",
        "Public": true,
        "NamespaceId": 2
      },
      {
        "Name": "mytest",
        "CreationTime": "2020-02-27T00:44:49+08:00",
        "Public": true,
        "NamespaceId": 1
      }
    ],
    "TotalCount": 2
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.ErrorTcrInternal Tcr实例内部错误
InternalError.ErrorTcrInvalidMediaType Tcr实例请求无效的Hearder类型
InternalError.ErrorTcrResourceConflict Tcr实例资源冲突
InternalError.ErrorTcrUnauthorized 没有Tcr操作权限
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
UnsupportedOperation 操作不支持。
目录