All Products
Search
Document Center

CloudOps Orchestration Service:ListParameters

Last Updated:Oct 14, 2024

Queries common parameters. Multiple methods are supported to filter common parameters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ListParameterslist
  • Parameter
    acs:oos:{#regionId}:{#accountId}:parameter/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
NamestringNo

The name of the common parameter.

MyParameter
MaxResultsintegerNo

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

50
NextTokenstringNo

The pagination token that can be used in the next request to retrieve a new 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 common parameter.

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.

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

The resource group ID.

rg-acfmxsn4m4******
ShareTypestringNo

The share type of the common parameter. Valid values:

  • Public
  • Private

Default value: Private.

‘Private’

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new 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 per page. Valid values: 10 to 100. Default value: 50.

50
Parametersarray<object>

The information about the common parameter.

Parameterobject

The information about the parameters.

Typestring

The data type of the common parameter.

String
UpdatedDatestring

The time when the common parameter was updated.

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

The user who updated the common parameter.

root(130900000)
Tagsobject

The tags added to the common parameter.

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

The description of the common parameter.

parameter
CreatedBystring

The user who created the common parameter.

root(130900000)
ResourceGroupIdstring

The resource group ID.

rg-acfmxsn4m4******
CreatedDatestring

The time when the common parameter was created.

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

The version number of the common parameter.

1
Namestring

The name of the common parameter.

MyParameter
Idstring

The common parameter ID.

p-4c4b401cab6747xxxxxx
ShareTypestring

The share type of the common 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": {
        "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

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

Change history

Change timeSummary of changesOperation
2023-05-15The request parameters of the API has changedView Change Details