Delete SAE Secrets Programmatically with DeleteSecret API - Serverless App Engine - Alibaba Cloud - Serverless App Engine

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:DeleteSecret

*All Resource

*

None

Request syntax

DELETE /pop/v1/sam/secret/secret HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The ID of the namespace. If the secret is in the default namespace, you need to specify only the region ID, for example, `cn-beijing`.	cn-beijing:test
SecretId	integer	Yes	The ID of the secret to delete. You can obtain the ID by calling the ListSecrets operation.	16

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The response message. success: The request was successful. If the request fails, an error message is returned.	success
TraceId	string	The ID used to trace the request.	0a98a02315955564772843261e****
Data	object	The returned data.
SecretId	integer	The ID of the deleted secret.	16
ErrorCode	string	The error code. The ErrorCode parameter is not returned if the request is successful. The ErrorCode parameter is returned if the request fails. For a list of error codes, see the Error codes section in this topic.	Null
Code	string	The HTTP status code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: A request error. 5xx: A server error.	200
Success	boolean	Indicates whether the secret was successfully deleted. Valid values: true: The secret was deleted. false: The secret was not deleted.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "SecretId": 16
  },
  "ErrorCode": "Null\n",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
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.
400	DependencyViolation.Job	The specified resource of secret is dependent on job [%s], so the operation cannot be completed.
400	DependencyViolation.Application	The specified resource of secret is dependent on application [%s], so the operation cannot be completed.
500	OperationFailed.RPCError	Internal RPC request processing error.	Internal RPC request processing error.
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.