Filter & Paginate OOS Parameters via ListParameters API - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Queries common parameters with support for multiple filtering methods.

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

list

*Parameter

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

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Name	string	No	The name of the common parameter.	MyParameter
MaxResults	integer	No	The number of entries per page. Valid values: 10 to 100. Default value: 50.	50
NextToken	string	No	A pagination token that retrieves the next page of results in a subsequent request.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
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
Type	string	No	The data type of the common parameter.	String
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	Specifies whether to recursively query parameters across all subdirectories in the specified path. Default value: false.	false
Tags	object	No	The tags.	{"k1": "v1", "k2": "v2"}
ResourceGroupId	string	No	The resource group ID.	rg-acfmxsn4m4******
ShareType	string	No	The share type of the common parameter. Valid values: Public Private Default value: Private.	‘Private’

Response elements

Element	Type	Description	Example
	object
NextToken	string	A pagination token. Use this token in a subsequent request to retrieve the next page of results.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb
RequestId	string	The request ID.	A81E4B2E-6B33-4BAE-9856-55DB7C893E01
TotalCount	integer	The total number of entries returned.	5
MaxResults	integer	The number of entries per page. Valid values: 10 to 100. Default value: 50.	50
Parameters	array<object>	The common parameter information.
	array<object>	The parameter information.
Type	string	The data type of the common parameter.	String
UpdatedDate	string	The time when the common parameter was updated.	2020-09-01T08:01:43Z
UpdatedBy	string	The user who updated the common parameter.	root(130900000)
Tags	object	The tags added to the common parameter.	{"k1": "v1", "k2": "v2"}
Description	string	The description of the common parameter.	parameter
CreatedBy	string	The user who created the common parameter.	root(130900000)
ResourceGroupId	string	The resource group ID.	rg-acfmxsn4m4******
CreatedDate	string	The time when the common parameter was created.	2020-09-01T08:01:43Z
ParameterVersion	string	The version number of the common parameter.	1
Name	string	The name of the common parameter.	MyParameter
Id	string	The common parameter ID.	p-4c4b401cab6747xxxxxx
ShareType	string	The share type of the common parameter.	Private

Examples

Success response

JSON format

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb",
  "RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
  "TotalCount": 5,
  "MaxResults": 50,
  "Parameters": [
    {
      "Type": "String",
      "UpdatedDate": "2020-09-01T08:01:43Z",
      "UpdatedBy": "root(130900000)",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "Description": "parameter",
      "CreatedBy": "root(130900000)",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedDate": "2020-09-01T08:01:43Z",
      "ParameterVersion": "1",
      "Name": "MyParameter",
      "Id": "p-4c4b401cab6747xxxxxx",
      "ShareType": "Private"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.