ListSecrets - - Alibaba Cloud Documentation Center

Queries the information about Secrets in a namespace.

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:ListSecrets		All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The ID of the namespace in which the Secrets reside. By default, the namespace ID is the same as the region ID.	cn-beijing:test

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. Take note of the following rules: If the call is successful, success is returned. If the call fails, an error code is returned.	success
TraceId	string	The trace ID that is used to query the details of the request.	0a98a02315955564772843261e****
Data	object	The data returned.
Secrets	array<object>	The Secrets.
Secret	object	The information about the Secret object.
NamespaceId	string	The namespace ID.	cn-beijing:test
SecretId	long	The Secret ID.	16
SecretName	string	The Secret name.	registry-auth
SecretType	string	The Secret type. Set the value to kubernetes.io/dockerconfigjson. The value indicates the secret for the username and password of the image repository and is used for authentication when images are pulled during application deployment.	kubernetes.io/dockerconfigjson
RelateApps	array<object>	The associated applications.
RelateApp	object	The information about the application.
AppName	string	The application name.	test-app
AppId	string	The application ID.	f16b4000-9058-4c22-a49d-49a28f0b****
CreateTime	long	The time when the Secret was created.	1593760185111
UpdateTime	long	The time when the Secret was updated.	1593760185111
ErrorCode	string	The error code returned. Take note of the following rules: 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 in this topic.	Null
Code	string	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the call is successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Secrets": [
      {
        "NamespaceId": "cn-beijing:test",
        "SecretId": 16,
        "SecretName": "registry-auth",
        "SecretType": "kubernetes.io/dockerconfigjson",
        "RelateApps": [
          {
            "AppName": "test-app",
            "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****"
          }
        ],
        "CreateTime": 1593760185111,
        "UpdateTime": 1593760185111
      }
    ]
  },
  "ErrorCode": "Null\n",
  "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
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