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

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /pop/v1/sam/configmap/configMap HTTPS|HTTP

请求参数

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

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

返回数据

名称 类型 示例值 描述
Code String 200

接口状态或POP错误码。

Data Struct

返回结果。

ConfigMapId Long 1

查询的ConfigMap实例ID。

CreateTime Long 1593746835111

创建时间。

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

ConfigMap键值对数据。

Description String test-desc

描述信息。

Name String test-configmap

ConfigMap实例名称。

NamespaceId String cn-hangzhou

命名空间ID。

RelateApps Array of RelateApp

关联的应用。

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

应用ID。

AppName String test-app

应用名称。

UpdateTime Long 1593747274195

更新时间。

ErrorCode String success

错误码。

Message String success

附加信息。

RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

请求ID。

Success Boolean true

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

  • true:表示查询成功。
  • false:表示查询失败。
TraceId String 0a98a02315955564772843261e****

调用链ID。

示例

请求示例

GET /pop/v1/sam/configmap/configMap HTTP/1.1
<公共请求头>
{
"ConfigMapId": "1"
}

正常返回示例

XML 格式

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

JSON 格式

{
    "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
    "Message": "success",
    "TraceId": "0a98a02315955564772843261e****",
    "Data": {
        "Description": "test-desc",
        "CreateTime": 1593746835111,
        "UpdateTime": 1593747274195,
        "RelateApps": {
            "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****",
            "AppName": "test-app"
        },
        "Data": "{\"k1\":\"v1\",\"k2\":\"v2\"}",
        "ConfigMapId": 1,
        "NamespaceId": "cn-hangzhou",
        "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。
404 InvalidNamespaceId.NotFound The specified NamespaceId does not exist. 指定的NamespaceId不存在。
400 NotFound.ConfigMap The ConfigMap object (ID: %s) does not exist. 找不到ConfigMap对象(ID=%s)。

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