All Products
Search
Document Center

CloudOps Orchestration Service:ListSecretParameterVersions

Last Updated:Mar 03, 2024

Queries versions of an encryption parameter.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
oos:ListSecretParameterVersionsLIST
  • secretparameter
    acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
NamestringYes

The name of the encryption parameter.

MySecretParameter
MaxResultsintegerNo

The number of entries per page. Valid values: 10 to 100. Default value: 50.

10
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results.

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
ShareTypestringNo

The share type of the encryption parameter.

Private
WithDecryptionbooleanNo

Specifies whether to decrypt the parameter value. The decrypted parameter value is returned only if this parameter is set to true. Otherwise, null is returned.

false

Response parameters

ParameterTypeDescriptionExample
object

The information about the encryption parameter.

Typestring

The type of the encryption parameter.

Secret
NextTokenstring

The pagination token that is used in the next request to retrieve a new page of results.

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
RequestIdstring

The ID of the request.

DBA6E6C8-F75D-41DE-AFF5-1FA03F551CA3
Descriptionstring

The description of the encryption parameter.

SecretParameter
MaxResultsinteger

The number of entries returned per page.

50
CreatedBystring

The user who created the encryption parameter.

root(130900000)
CreatedDatestring

The time when the encryption parameter was created.

2020-09-01T08:01:43Z
Namestring

The name of the encryption parameter.

MySecretParameter
TotalCountinteger

The total number of entries returned.

1
Idstring

The ID of the encryption parameter.

p-4c4b401cab6747xxxxxx
ParameterVersionsobject []

The information about the version of the encryption parameter.

ParameterVersioninteger

The version number of the encryption parameter.

1
Valuestring

The value of the encryption parameter.

SecretParameter
UpdatedDatestring

The time when the encryption parameter was updated.

2020-09-01T08:01:43Z
UpdatedBystring

The user who updated the encryption parameter.

root(130900000)

Examples

Sample success responses

JSONformat

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

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