All Products
Search
Document Center

CloudOps Orchestration Service:ListSecretParameters

Last Updated:Sep 05, 2024

Queries common parameters. Multiple types of queries are supported.

Operation description

Before you call this operation, make sure that you have the permission to manage Key Management Service (KMS) secrets.

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:ListSecretParameterslist
  • SecretParameter
    acs:oos:{#regionId}:{#accountId}:secretparameter/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
NamestringNo

The name of the parameter. **You can enter a keyword to query parameter names in fuzzy match mode.

MySecretParameter
MaxResultsintegerNo

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

50
NextTokenstringNo

The token that is used to retrieve the next page of results.

sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA
SortFieldstringNo

The field used to sort the query results. Valid values:

  • Name
  • CreatedDate
Name
SortOrderstringNo

The order in which the entries are sorted. Valid values:

  • Ascending
  • Descending (Default)
Descending
PathstringNo

The path of the parameter. For example, if the name of a parameter is /path/path1/Myparameter, the path of the parameter is /path/path1/.

/path1/path2/
RecursivebooleanNo

Specifies whether to query parameters from all levels of directories in the specified path. Default value: false.

false
TagsobjectNo

The tags of the parameter.

{"k1": "v1", "k2": "v2"}
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmxsn4m4******

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The token that is used to retrieve the next page of results.

sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA
RequestIdstring

The ID of the request.

CA9C6248-AF2A-4AE9-A166-88FD901BBB90
MaxResultsinteger

The number of entries returned per page.

50
Parametersarray<object>

The information about the parameters.

object
Typestring

The type of the parameter.

Secret
UpdatedDatestring

The time when the parameter was updated.

2020-09-01T09:35:17Z
UpdatedBystring

The user who updated the parameter.

root(130900000)
KeyIdstring

The ID of the KMS customer master key (CMK) that is used for encryption.

80e9409f-78fa-42ab-84bd-83f40c******
Tagsobject

The tags of the parameter.

{"k1": "v1", "k2": "v2"}
Descriptionstring

The description of the parameter.

SecretParameter
ResourceGroupIdstring

The ID of the resource group.

rg-acfmxsn4m4******
CreatedBystring

The user who created the parameter.

root(130900000)
CreatedDatestring

The time when the parameter was created.

2020-09-01T09:28:47Z
ParameterVersionstring

The version number of the parameter.

1
Namestring

The name of the parameter.

MySecretParameter
Idstring

The ID of the parameter.

p-14ed150fdcd048xxxxxx
ShareTypestring

The share type of the parameter.

Private

Examples

Sample success responses

JSONformat

{
  "NextToken": "sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA",
  "RequestId": "CA9C6248-AF2A-4AE9-A166-88FD901BBB90",
  "MaxResults": 50,
  "Parameters": [
    {
      "Type": "Secret",
      "UpdatedDate": "2020-09-01T09:35:17Z",
      "UpdatedBy": "root(130900000)",
      "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "Description": "SecretParameter",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-09-01T09:28:47Z",
      "ParameterVersion": "1",
      "Name": "MySecretParameter",
      "Id": "p-14ed150fdcd048xxxxxx",
      "ShareType": "Private"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history