ListSecretParameterVersions - CloudOps Orchestration Service

Queries multiple versions of a encrypted parameter.

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

oos:ListSecretParameterVersions

list

*secretparameter

acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
Name	string	Yes	The name of the parameter.	MySecretParameter
MaxResults	integer	No	The number of entries to return on each page. Valid values: 10 to 100. Default value: 50.	10
NextToken	string	No	The pagination token.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
ShareType	string	No	The share type of the parameter.	Private
WithDecryption	boolean	No	Specifies whether to decrypt the parameter value. The parameter value is returned in the Value response parameter only if this parameter is set to true. Otherwise, the Value response parameter is empty.	false

Response elements

Element	Type	Description	Example
	object	The information about the secret parameter.
Type	string	The type of the parameter.	Secret
NextToken	string	The pagination token.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
RequestId	string	The ID of the request.	DBA6E6C8-F75D-41DE-AFF5-1FA03F551CA3
Description	string	The description of the parameter.	SecretParameter
MaxResults	integer	The number of entries returned per page.	50
CreatedBy	string	The user who created the parameter.	root(130900000)
CreatedDate	string	The time when the parameter was created.	2020-09-01T08:01:43Z
Name	string	The name of the parameter.	MySecretParameter
TotalCount	integer	The total number of entries returned.	1
Id	string	The ID of the parameter.	p-4c4b401cab6747xxxxxx
ParameterVersions	array<object>	The versions of the parameter.
	object	The details of a version.
ParameterVersion	integer	The version number of the parameter.	1
Value	string	The value of the parameter.	SecretParameter
UpdatedDate	string	The time when the parameter was last updated.	2020-09-01T08:01:43Z
UpdatedBy	string	The user who last updated the parameter.	root(130900000)

Examples

Success response

JSON format

{
  "Type": "Secret",
  "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB",
  "RequestId": "DBA6E6C8-F75D-41DE-AFF5-1FA03F551CA3",
  "Description": "SecretParameter",
  "MaxResults": 50,
  "CreatedBy": "root(130900000)",
  "CreatedDate": "2020-09-01T08:01:43Z",
  "Name": "MySecretParameter",
  "TotalCount": 1,
  "Id": "p-4c4b401cab6747xxxxxx",
  "ParameterVersions": [
    {
      "ParameterVersion": 1,
      "Value": "SecretParameter",
      "UpdatedDate": "2020-09-01T08:01:43Z",
      "UpdatedBy": "root(130900000)"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.