UpdateSecret - Serverless App Engine - Alibaba Cloud Documentation Center

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

*All Resource

*

None

Request syntax

PUT /pop/v1/sam/secret/secret HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The ID of the namespace where the Secret instance is located. If the instance is in the default namespace, specify only the region ID, such as `cn-beijing`.	cn-beijing:test
SecretId	integer	Yes	The ID of the Secret instance.	16
SecretData	object	Yes	The Secret data.
SecretData	string	Yes	The key-value pairs of the Secret. This parameter is required. The value must be a JSON object. For more information about configuration items, see Manage and use secrets. k specifies a key and v specifies a value. For more information about configuration items, see Manage and use secrets.	{".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Additional information about the call result.	success
TraceId	string	The ID of the call chain. You can use this ID to query the details of a call.	0a98a02315955564772843261e****
Data	object	The returned result.
SecretId	integer	The ID of the Secret instance.	16
ErrorCode	string	The error code. The following list describes the values: If the request is successful, this parameter is not returned. If the request fails, this parameter is returned. For more information, see the Error codes section of this topic.	空
Code	string	The status of the API call or a POP error code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: A request error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the Secret instance was updated. Valid values: true: The instance was updated. false: The update failed.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "SecretId": 16
  },
  "ErrorCode": "空",
  "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	InvalidSecretDataKey.NotFound	The specified Key [%s] does not exist in the specified Secret [%s].
500	OperationFailed.RPCError	Internal RPC request processing error.	Internal RPC request processing error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.