文档

ListK8sSecrets - 获取K8s保密配置列表

更新时间:

调用ListK8sSecrets接口获取K8s保密配置列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /pop/v5/k8s/acs/k8s_secret

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

7a953f9a-2946-4c7a-9d82-9939db******
Namespacestring

K8s 集群命名空间。

default
RegionIdstring

阿里云地域 ID。

cn-hangzhou
PageNointeger

当前页码,从 0 开始计数。

0
PageSizeinteger

分页查询,每页显示的条数。值为 0 时不进行分页,返回所有内容。

10
Conditionstring

过滤条件,JSON 对象字符串,示例:{"field":"Name", "pattern":"configmap-"}。

{\"field\":\"Name\",\"pattern\":\"product\"}
ShowRelatedAppsboolean

返回使用该保密配置的应用列表。

true

返回参数

名称类型描述示例值
object
Codeinteger

接口状态或 POP 错误码。

200
Messagestring

附加信息。

success
RequestIdstring

请求 ID。

b197-40ab-9155-****
Resultobject

K8s 保密配置查询结果。

Totalinteger

总记录数。

6
Secretsobject []

保密配置列表。

Typestring

保密配置类型,支持以下两种类型:

  • Opaque:用户自定义数据类型。

  • kubernetes.io/tls:TLS 证书类型。

Opaque
CreationTimestring

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2022-05-26T02:57:02Z
ClusterNamestring

集群名称。

test-cluster
Namespacestring

K8s 集群命名空间。

default
Base64Encodedboolean

数据是否进过 base64 编码:

  • true:已编码。
  • false:未编码。
false
CertRegionIdstring

证书所属的区域。

cn-hangzhou
CertIdstring

阿里云证书服务的证书 ID。

123456
Namestring

保密配置名称,必须以字母开头,支持数字、字母和短划线(-),最多支持 63 个字符。

my-secret
ClusterIdstring

EDAS 集群 ID。

4472a6d3-f01d-4087-85a7-3dc52********
RelatedIngressRulesobject []

关联的应用路由规则列表。

Namestring

应用路由规则名称。

testrulename
Namespacestring

K8s 命名空间。

default
RelatedAppsobject []

应用路由关联应用列表。

AppNamestring

EDAS 应用名称。

app-test
AppIdstring

应用 ID。

6dc74432-5a35-4e68-8aaa-3700********
Dataobject []

保密配置数据。

Keystring

用户自定义的 secret 键。

name
Valuestring

用户自定义的 secret 值。

william
RelatedAppsobject []

使用了该保密配置的应用列表。

AppNamestring

应用名称。

my-app
AppIdstring

应用 ID。

b08eeb18-8946-410c-a1ea-dbbc********
CertDetailobject

SSL 证书详情。

EndTimestring

证书结束时间。

2022-02-22T02:32:41Z
Statusstring

证书状态:

  • normal:有效证书。
  • invalid:无效证书。
  • expired:证书已过期。
  • not_yet_valid:尚未到生效时间。
  • about_to_expire:证书即将过期。
normal
StartTimestring

证书生效时间。

2022-01-02T22:40:00Z
Issuerstring

证书颁发机构。

CN=GlobalSign Root CA, OU=Root CA, O=GlobalSign nv-sa, C=BE
DomainNamesarray

SSL 证书关联的域名列表。

string

域名。

example.com

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-****",
  "Result": {
    "Total": 6,
    "Secrets": [
      {
        "Type": "Opaque",
        "CreationTime": "2022-05-26T02:57:02Z",
        "ClusterName": "test-cluster",
        "Namespace": "default",
        "Base64Encoded": false,
        "CertRegionId": "cn-hangzhou",
        "CertId": "123456",
        "Name": "my-secret",
        "ClusterId": "4472a6d3-f01d-4087-85a7-3dc52********",
        "RelatedIngressRules": [
          {
            "Name": "testrulename",
            "Namespace": "default",
            "RelatedApps": [
              {
                "AppName": "app-test",
                "AppId": "6dc74432-5a35-4e68-8aaa-3700********"
              }
            ]
          }
        ],
        "Data": [
          {
            "Key": "name",
            "Value": "william"
          }
        ],
        "RelatedApps": [
          {
            "AppName": "my-app",
            "AppId": "b08eeb18-8946-410c-a1ea-dbbc********"
          }
        ],
        "CertDetail": {
          "EndTime": "2022-02-22T02:32:41Z",
          "Status": "normal",
          "StartTime": "2022-01-02T22:40:00Z",
          "Issuer": "CN=GlobalSign Root CA, OU=Root CA, O=GlobalSign nv-sa, C=BE",
          "DomainNames": [
            "example.com"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
500Edas.errorcode.PermissionDenied.messageYou are not authorized to perform the operation.无权限操作

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

变更历史

变更时间变更内容概要操作
2021-09-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
出参OpenAPI 返回结构发生变更