DescribeConfigMap-阿里云帮助中心

Queries the details of a ConfigMap instance.

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

sae:DescribeConfigMap

get

*All Resource

*

None

Request syntax

GET /pop/v1/sam/configmap/configMap HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ConfigMapId	integer	Yes	The ID of the ConfigMap. You can call the ListNamespacedConfigMaps operation to obtain the ID.	1

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. The value is success if the request succeeds. The value is an error code if the request fails.	success
TraceId	string	The trace ID. You can use it to locate the call details.	0a98a02315955564772843261e****
Data	object	The returned data.
UpdateTime	integer	The time when the instance was last updated.	1593747274195
Data	object	The key-value pairs of the ConfigMap. The data is in the following format: {"k1":"v1", "k2":"v2"} For more information about configuration items, see Manage and use configuration items.	{"k1":"v1","k2":"v2"}
NamespaceId	string	The namespace ID.	cn-hangzhou
Description	string	The description of the ConfigMap instance.	test-desc
CreateTime	integer	The time when the instance was created.	1593746835111
RelateApps	array<object>	The associated applications.
	object	The application details.
AppName	string	The application name.	test-app
AppId	string	The application ID.	f16b4000-9058-4c22-a49d-49a28f0b****
ConfigMapId	integer	The ID of the ConfigMap instance.	1
Name	string	The name of the ConfigMap instance.	test-configmap
ErrorCode	string	The error code returned if the request fails. This parameter is empty if the request succeeds. This parameter contains an error code if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. Valid values: 2xx: success 3xx: redirection 4xx: client error 5xx: server error	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "UpdateTime": 1593747274195,
    "Data": {
      "k1": "v1",
      "k2": "v2"
    },
    "NamespaceId": "cn-hangzhou",
    "Description": "test-desc",
    "CreateTime": 1593746835111,
    "RelateApps": [
      {
        "AppName": "test-app",
        "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****"
      }
    ],
    "ConfigMapId": 1,
    "Name": "test-configmap"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	NotFound.ConfigMap	The ConfigMap object (ID: %s) does not exist.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.