ListK8sConfigMaps - Enterprise Distributed Application Service

Queries Kubernetes ConfigMaps.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ReadCluster

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
ClusterId	string	No	The ID of the cluster.	c0830281-366c-41b6-80fb-542e76******
Namespace	string	No	The namespace of the Kubernetes cluster.	default
PageNo	integer	No	The number of the page to return. Pages start from Page 0.	0
PageSize	integer	No	The number of entries to return on each page.	50
Condition	string	No	The filter conditions. Set this parameter to a JSON string in the format of {"field":"Name", "pattern":"configmap-"}.	{"field":"Name", "pattern":"configmap-"}
ShowRelatedApps	boolean	No	Specifies whether to return a list of applications that use a ConfigMap. Valid values: true and false.	true

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	D16979DC-4D42-****************
Result	object	The query results that are returned.
Total	integer	The total number of entries that are returned.	6
ConfigMaps	array<object>	The information about ConfigMaps.
	array<object>
CreationTime	string	The time when the ConfigMaps were created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2022-01-31T02:46:14Z
ClusterName	string	The name of the cluster.	my-cluster
Namespace	string	The namespace of the Kubernetes cluster.	default
Name	string	The name of the ConfigMap.	my-config
ClusterId	string	The ID of the Kubernetes cluster. You can obtain the cluster ID by calling the GetK8sCluster operation. For more information, see GetK8sCluster.	d73918f4-3b08-4c17-bb07-eaf8********
Data	array<object>	The information about ConfigMaps.
	object
Key	string	The user-defined key that is stored in the ConfigMap.	name
Value	string	The user-defined value that is stored in the ConfigMap.	william
RelatedApps	array<object>	The related applications.
	object
AppName	string	The name of the application.	my-app
AppId	string	The ID of the application.	728cbdf2-da10-49b8-b69c-9168a********

Examples

Success response

JSON format

{
  "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********"
          }
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	Edas.errorcode.PermissionDenied.message	You are not authorized to perform the operation.	No permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.