DeleteSecret - - Alibaba Cloud Documentation Center

Deletes a Secret.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DeleteSecret		All Resources *	none	none

Request syntax

DELETE /pop/v1/sam/secret/secret

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The ID of the namespace in which the Secret resides. By default, the namespace ID is the same as the region ID.	cn-beijing:test
SecretId	long	Yes	The ID of the Secret to be deleted. You can call the ListSecrets operation to view the Secret IDs.	16

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The additional information that is returned. Valid values: success: If the call is successful, success is returned. An error code: 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 response.
SecretId	long	The ID of the deleted Secret.	16
ErrorCode	string	The error code returned. Valid values: The ErrorCode parameter is not returned if the request succeeds. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of 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 Secret is successfully deleted. Valid values: true: The instance was deleted. false: The instance failed to be deleted.	true

Examples

Sample success responses

JSONformat

{
  "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.	-
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.	-
500	OperationFailed.RPCError	Internal RPC request processing error.	Internal RPC request processing error.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history