调用DescribeSecret接口查询Secret实例详情。

调试

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

请求头

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

请求语法

GET /pop/v1/sam/secret/secret HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
NamespaceId String Query 是 cn-beijing:test

Secret实例所在命名空间ID。默认同RegionId。
SecretId Long Query 是 16

查询的Secret实例ID。需要调用ListSecrets接口查看。

返回数据

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

请求ID。
Message String success

附加信息。取值说明如下：

  • 请求正常，返回success。
  • 请求异常，返回具体异常错误码。
TraceId String 0a98a02315955564772843261e****

调用链ID，用于精确查询调用信息。
Data Object

返回结果。
NamespaceId String cn-beijing:test

命名空间ID。
SecretId Long 16

Secret实例ID。
SecretName String registry-auth

Secret实例名称。
SecretType String kubernetes.io/dockerconfigjson

Secret实例类型。
SecretData Map

Secret键值对数据。
String {".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}

Secret键值对数据。
CreateTime Long 1593746835111

创建时间。
UpdateTime Long 1593746835111

更新时间。
RelateApps Array of RelateApp

关联的应用。
AppId String f16b4000-9058-4c22-a49d-49a28f0b****

应用ID。
AppName String test-app

应用名称。
ErrorCode String 空

错误码。取值说明如下：

  • 请求成功：不返回ErrorCode字段。
  • 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。
Code String 200

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

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

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

  • true：查询成功。
  • false：查询失败。

示例

请求示例

GET /pop/v1/sam/secret/secret?NamespaceId=cn-beijing:test&SecretId=16 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式 

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

<DescribeSecretResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>
        <NamespaceId>cn-beijing:test</NamespaceId>
        <SecretId>16</SecretId>
        <SecretName>registry-auth</SecretName>
        <SecretType>kubernetes.io/dockerconfigjson</SecretType>
        <SecretData>
            <key>{".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}</key>
        </SecretData>
        <CreateTime>1593746835111</CreateTime>
        <UpdateTime>1593746835111</UpdateTime>
        <RelateApps>
            <AppId>f16b4000-9058-4c22-a49d-49a28f0b****</AppId>
            <AppName>test-app</AppName>
        </RelateApps>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeSecretResponse>

JSON格式 

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

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a98a02315955564772843261e****",
  "Data" : {
    "NamespaceId" : "cn-beijing:test",
    "SecretId" : 16,
    "SecretName" : "registry-auth",
    "SecretType" : "kubernetes.io/dockerconfigjson",
    "SecretData" : {
      "key" : "{\".dockerconfigjson\":\"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0=\"}"
    },
    "CreateTime" : 1593746835111,
    "UpdateTime" : 1593746835111,
    "RelateApps" : [ {
      "AppId" : "f16b4000-9058-4c22-a49d-49a28f0b****",
      "AppName" : "test-app"
    } ]
  },
  "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 InvalidSecretId.NotFound The specified SecretId [%s] does not exist in our records. 指定的保密字典ID[%s]不存在。
404 InvalidNamespaceId.NotFound The specified NamespaceId does not exist. 指定的NamespaceId不存在。

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