List Namespace Secrets Using the ListSecrets API - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Call ListSecrets to list Secrets in a namespace.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:ListSecrets

*All Resource

*

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 that contains the Secret. For the default namespace, use the region ID, such as `cn-beijing`.	cn-beijing:test

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. If the request is successful, success is returned. If the request fails, an error message is returned.	success
TraceId	string	The trace ID. You can use this ID to query the details of a call.	0a98a02315955564772843261e****
Data	object	The response object.
Secrets	array<object>	A list of Secret instances.
	array<object>	The details of a Secret instance.
NamespaceId	string	The namespace ID.	cn-beijing:test
SecretId	integer	The Secret instance ID.	16
SecretName	string	The Secret instance name.	registry-auth
SecretType	string	The type of the Secret instance. The only valid value is: kubernetes.io/dockerconfigjson: a Secret that stores credentials for a container image registry and is used to authenticate image pulls during deployment.	kubernetes.io/dockerconfigjson
RelateApps	array<object>	The associated applications.
	object	The details of an application.
AppName	string	The application name.	test-app
AppId	string	The application ID.	f16b4000-9058-4c22-a49d-49a28f0b****
CreateTime	integer	The time when the Secret instance was created.	1593760185111
UpdateTime	integer	The time when the Secret instance was last updated.	1593760185111
ErrorCode	string	The error code. This parameter is not returned if the request is successful. This parameter is returned if the request fails. For more information, see the Error codes section.	Null
Code	string	The HTTP status code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.