ListK8sConfigMaps - 获取K8s配置项列表

调用ListK8sConfigMaps接口获取K8s配置项列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadClusterget
*全部资源
*

请求语法

GET /pop/v5/k8s/acs/k8s_config_map HTTP/1.1

请求参数

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

阿里云地域 ID。

cn-hangzhou
ClusterIdstring

集群 ID。

c0830281-366c-41b6-80fb-542e76******
Namespacestring

K8s 集群命名空间。

default
PageNointeger

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

0
PageSizeinteger

分页查询,每页显示的条数。

50
Conditionstring

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

{"field":"Name", "pattern":"configmap-"}
ShowRelatedAppsboolean

是否返回使用该配置项的应用列表,true 表示返回,false 表示不返回。

true

返回参数

名称类型描述示例值
object
Codeinteger

接口状态或 pop 错误码。

200
Messagestring

附加信息。

success
RequestIdstring

请求 ID。

D16979DC-4D42-****************
Resultobject

检索结果。

Totalinteger

总记录数。

6
ConfigMapsarray<object>

配置项列表。

ConfigMapsobject
CreationTimestring

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

2022-01-31T02:46:14Z
ClusterNamestring

集群名称。

my-cluster
Namespacestring

K8s 命名空间。

default
Namestring

配置项名称。

my-config
ClusterIdstring

集群 ID,可通过调用 GetK8sCluster 接口获取,请参见 GetK8sCluster

d73918f4-3b08-4c17-bb07-eaf8********
Dataarray<object>

配置项数据列表。

Dataobject
Keystring

用户自定义 ConfigMap 键。

name
Valuestring

用户自定义 ConfigMap 值。

william
RelatedAppsarray<object>

关联的应用列表。

RelatedAppsobject
AppNamestring

应用名称。

my-app
AppIdstring

应用 ID。

728cbdf2-da10-49b8-b69c-9168a********

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "D16979DC-4D42-****************",
  "Result": {
    "Total": 6,
    "ConfigMaps": [
      {
        "CreationTime": "2022-01-31T02:46:14Z",
        "ClusterName": "my-cluster",
        "Namespace": "default",
        "Name": "my-config",
        "ClusterId": "d73918f4-3b08-4c17-bb07-eaf8********",
        "Data": [
          {
            "Key": "name",
            "Value": "william"
          }
        ],
        "RelatedApps": [
          {
            "AppName": "my-app",
            "AppId": "728cbdf2-da10-49b8-b69c-9168a********"
          }
        ]
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史