ListSecrets - ListSecrets -

调用ListSecrets接口获取命名空间内Secret实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sae:ListSecrets		全部资源 *	无	无

请求语法

GET /pop/v1/sam/secret/secrets HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
NamespaceId	string	是	Secret 实例所在命名空间 ID。默认同 RegionId。	cn-beijing:test

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	附加信息。取值说明如下：请求正常，返回 success。请求异常，返回具体异常错误码。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	0a98a02315955564772843261e****
Data	object	返回结果。
Secrets	array<object>	Secret 实例列表。
Secret	object	Secret 实例的具体信息。
NamespaceId	string	命名空间 ID。	cn-beijing:test
SecretId	long	Secret 实例 ID。	16
SecretName	string	Secret 实例名称。	registry-auth
SecretType	string	Secret 实例类型。取值说明如下： kubernetes.io/dockerconfigjson：存储镜像仓库用户名和密码的保密字典，用于部署时拉取镜像鉴权。	kubernetes.io/dockerconfigjson
RelateApps	array<object>	关联应用。
RelateApp	object	应用的具体信息。
AppName	string	应用名称。	test-app
AppId	string	应用 ID。	f16b4000-9058-4c22-a49d-49a28f0b****
CreateTime	long	创建时间。	1593760185111
UpdateTime	long	更新时间。	1593760185111
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。	空
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	是否成功获取 Secret 实例列表。取值说明如下： true：获取成功。 false：获取失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Secrets": [
      {
        "NamespaceId": "cn-beijing:test",
        "SecretId": 16,
        "SecretName": "registry-auth",
        "SecretType": "kubernetes.io/dockerconfigjson",
        "RelateApps": [
          {
            "AppName": "test-app",
            "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****"
          }
        ],
        "CreateTime": 1593760185111,
        "UpdateTime": 1593760185111
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的参数：%s不能为空。
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的参数{%s}。
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	不合法的参数{%s}：%s。
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.	指定的NamespaceId不存在。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史