All Products
Search
Document Center

Operation Orchestration Service:ListParameters

Last Updated:Mar 20, 2023

Queries common parameters. Multiple types of queries are supported.

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 keyAssociation operation
oos:ListParametersLIST
  • OOS
    acs:oos:{#regionId}:{#accountId}:parameter/*
    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.

MyParameter
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 10 to 100. Default value: 50.

50
NextTokenstringNo

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

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
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
TypestringNo

The data type of the parameter. Valid values:

  • String
  • StringList
String
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.

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.

gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb
RequestIdstring

The ID of the request.

A81E4B2E-6B33-4BAE-9856-55DB7C893E01
TotalCountinteger

The total number of entries returned.

5
MaxResultsinteger

The number of entries returned per page.

50
Parametersarray

The information about the common parameters.

object
Typestring

The type of the parameter.

String
UpdatedDatestring

The time when the parameter was updated.

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

The user who updated the parameter.

root(130900000)
Tagsobject

The tags of the parameter.

Descriptionstring

The description of the parameter.

parameter
CreatedBystring

The user who created the parameter.

root(130900000)
ResourceGroupIdstring

The ID of the resource group.

rg-acfmxsn4m4******
CreatedDatestring

The time when the parameter was created.

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

The version number of the parameter.

1
Namestring

The name of the parameter.

MyParameter
Idstring

The ID of the parameter.

p-4c4b401cab6747xxxxxx
ShareTypestring

The share type of the parameter.

Private

Examples

Sample success responses

JSONformat

{
  "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": {
        "test": "test",
        "test2": 1
      },
      "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

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