DescribeConfigMap - - Alibaba Cloud Documentation Center

Queries the details of a ConfigMap.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:DescribeConfigMap	get	All Resources *	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
ConfigMapId	long	Yes	The ID of the request.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The returned information. Valid values: If the call is successful, success is returned. If the call fails, an error code is returned.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The ID of the trace. The ID is used to query the details of a request.	success
TraceId	string	The returned result.	0a98a02315955564772843261e****
Data	object	The time when the instance was last modified.
UpdateTime	long	The data of ConfigMap key-value pairs. Format: {"k1":"v1", "k2":"v2"} k specifies a key and v specifies a value. For more information, see Manage and use configurations.	1593747274195
Data	object	The ID of the namespace to which the instance belongs.	{"k1":"v1","k2":"v2"}
NamespaceId	string	The description of the instance.	cn-hangzhou
Description	string	The time when the instance was created.	test-desc
CreateTime	long	The application that is associated with the instance.	1593746835111
RelateApps	array<object>	The name of the application.
RelateApp	object
AppName	string	The ID of the application.	test-app
AppId	string	The ID of the ConfigMap instance.	f16b4000-9058-4c22-a49d-49a28f0b****
ConfigMapId	long	The name of the ConfigMap instance.	1
Name	string	The returned error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.	test-configmap
ErrorCode	string	The HTTP status code. Valid values: 2xx: indicates that the call was successful. 3xx: indicates that the call was redirected. 4xx: indicates that the call failed. 5xx: indicates that a server error occurred.
Code	string	Indicates whether the details of the ConfigMap instance were obtained. Valid values: true: The details were obtained. false: The details failed to be obtained.	200

Examples

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history