DescribeSecret - Serverless App Engine - Centro de documentación de Alibaba Cloud

Consulta los detalles de un secreto.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sae:DescribeSecret

*All Resource

*

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
NamespaceId	string	Sí	El ID del espacio de nombres donde reside el secreto. Si el espacio de nombres es el predeterminado, solo necesita ingresar el ID de la región, como `cn-beijing`.	cn-beijing:test
SecretId	integer	Sí	El ID de la instancia del secreto que se va a consultar. Puede llamar a la operación ListSecrets para ver los ID de las instancias de secretos.	16

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
RequestId	string	El ID de la solicitud.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	La información adicional que se devuelve. Valores válidos: success: Si la llamada es exitosa, se devuelve success. Un código de error: Si la llamada falla, se devuelve un código de error.	success
TraceId	string	El ID de rastreo que se utiliza para consultar los detalles de la solicitud.	0a98a02315955564772843261e****
Data	object	La respuesta.
NamespaceId	string	El ID del espacio de nombres.	cn-beijing:test
SecretId	integer	El ID de la instancia del secreto.	16
SecretName	string	El nombre de la instancia del secreto.	registry-auth
SecretType	string	El tipo de la instancia del secreto.	kubernetes.io/dockerconfigjson
SecretData	object	Datos de pares clave-valor del secreto.
	string	Datos de pares clave-valor del secreto.	{".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}
CreateTime	integer	La hora en que se creó la tarea.	1593746835111
UpdateTime	integer	La hora en que se actualizó la tarea.	1593746835111
RelateApps	array<object>	La aplicación asociada.
	object	La información sobre la aplicación.
AppId	string	El ID de la aplicación.	f16b4000-9058-4c22-a49d-49a28f0b****
AppName	string	El nombre de la aplicación.	test-app
ErrorCode	string	El código de error devuelto. Valores válidos: El parámetro ErrorCode no se devuelve si la solicitud es exitosa. Si la llamada falla, se devuelve el parámetro ErrorCode. Para obtener más información, consulte Códigos de error en este tema.
Code	string	El código de estado HTTP. Valores válidos: 2xx: La llamada fue exitosa. 3xx: La llamada fue redirigida. 4xx: La llamada falló. 5xx: Ocurrió un error del servidor.	200
Success	boolean	Indica si los detalles de la instancia del secreto se consultaron correctamente. Valores válidos: true: La información se consultó correctamente. false: No se pudo encontrar la imagen.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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"
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
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	InvalidSecretId.NotFound	The specified SecretId [%s] does not exist in our records.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.