Query secret parameters using ListSecretParameters - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Queries secret parameters. You can filter results by name, path, tag, and resource group.

Operation description

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

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

list

*SecretParameter

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

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
Name	string	No	The name of the parameter. You can enter a keyword to query parameter names in fuzzy match mode.	MySecretParameter
MaxResults	integer	No	The number of entries per page. Valid values: 10 to 100. Default value: 50.	50
NextToken	string	No	The token used to retrieve the next page of results.	sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA
SortField	string	No	The field used to sort the query results. Valid values: Name CreatedDate	Name
SortOrder	string	No	The order in which the entries are sorted. Valid values: Ascending Descending (Default)	Descending
Path	string	No	The path of the parameter. For example, if the parameter name is /path/path1/Myparameter, the path is /path/path1/.	/path1/path2/
Recursive	boolean	No	Whether to query parameters from all directory levels in the specified path. Default value: false.	false
Tags	object	No	The tags of the parameter.	{"k1": "v1", "k2": "v2"}
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxsn4m4******

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token used to retrieve the next page of results.	sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA
RequestId	string	The ID of the request.	CA9C6248-AF2A-4AE9-A166-88FD901BBB90
MaxResults	integer	The number of entries returned per page.	50
Parameters	array<object>	The information about the parameters.
	array<object>
Type	string	The type of the parameter.	Secret
UpdatedDate	string	The time when the parameter was updated.	2020-09-01T09:35:17Z
UpdatedBy	string	The user who updated the parameter.	root(130900000)
KeyId	string	The ID of the KMS customer master key (CMK) used for encryption.	80e9409f-78fa-42ab-84bd-83f40c******
Tags	object	The tags of the parameter.	{"k1": "v1", "k2": "v2"}
Description	string	The description of the parameter.	SecretParameter
ResourceGroupId	string	The ID of the resource group.	rg-acfmxsn4m4******
CreatedBy	string	The user who created the parameter.	root(130900000)
CreatedDate	string	The time when the parameter was created.	2020-09-01T09:28:47Z
ParameterVersion	string	The version number of the parameter.	1
Name	string	The name of the parameter.	MySecretParameter
Id	string	The ID of the parameter.	p-14ed150fdcd048xxxxxx
ShareType	string	The share type of the parameter.	Private

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.