调用DescribeConfigMap接口查询ConfigMap实例详情。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
ConfigMapId Long Query 1

查询的ConfigMap实例ID。需要调用ListNamespacedConfigMaps接口查看。

返回数据

名称 类型 示例值 描述
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

请求ID。

Message String success

调用结果的附加信息。

TraceId String success

错误码。

Data Object

返回结果。

UpdateTime Long 1593747274195

更新时间。

Data Map

ConfigMap键值对数据。格式如下:

{"k1":"v1", "k2":"v2"}

k表示键,v表示值。关于配置项的更多信息,请参见管理和使用配置项

NamespaceId String cn-hangzhou

命名空间ID。

Description String test-desc

描述信息。

CreateTime Long 1593746835111

创建时间。

RelateApps Array of RelateApp

关联的应用。

AppName String test-app

应用名称。

AppId String f16b4000-9058-4c22-a49d-49a28f0b****

应用ID。

ConfigMapId Long 1

查询的ConfigMap实例ID。

Name String test-configmap

ConfigMap实例名称。

ErrorCode String success

错误码。

Code String 200

接口状态或POP错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
Success Boolean true

查询ConfigMap实例详情是否成功。取值说明如下:

  • true:表示查询成功。
  • false:表示查询失败。

示例

请求示例

GET /pop/v1/sam/configmap/configMap?ConfigMapId=1 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeConfigMapResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>success</TraceId>
    <Data>
        <UpdateTime>1593747274195</UpdateTime>
        <NamespaceId>cn-hangzhou</NamespaceId>
        <Description>test-desc</Description>
        <CreateTime>1593746835111</CreateTime>
        <RelateApps>
            <AppName>test-app</AppName>
            <AppId>f16b4000-9058-4c22-a49d-49a28f0b****</AppId>
        </RelateApps>
        <ConfigMapId>1</ConfigMapId>
        <Name>test-configmap</Name>
    </Data>
    <ErrorCode>success</ErrorCode>
    <Code>200</Code>
    <Success>true</Success>
</DescribeConfigMapResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter.NotEmpty You must specify the parameter %s. 不合法的参数:%s不能为空。
400 InvalidParameter.Obviously The specified parameter is invalid {%s}. 不合法的参数{%s}。
400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s 不合法的参数{%s}:%s。
400 NotFound.ConfigMap The ConfigMap object (ID: %s) does not exist. 找不到ConfigMap对象(ID=%s)。
404 InvalidNamespaceId.NotFound The specified NamespaceId does not exist. 指定的NamespaceId不存在。

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