Queries common parameters. You can set various filters for the query.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListParameters

The operation that you want to perform. Set the value to ListParameters.

RegionId String No cn-hangzhou

The ID of the region.

Name String No MyParameter

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

MaxResults Integer No 50

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

NextToken String No MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA

The pagination token.

SortField String No Name

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

  • Name
  • CreatedDate
SortOrder String No Descending

The sorting order of the query results. Valid values:

  • Ascending
  • Descending (Default)
Type String No String

The data type of the common parameter. Valid values:

  • String
  • StringList
Path String No /path1/path2/

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

Recursive Boolean No false

Specifies whether to query parameters from all levels of directories in the specified path.

Default value: false.

Response parameters

Parameter Type Example Description
MaxResults Integer 50

The number of entries returned per page.

NextToken String gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb

The pagination token.

Parameters Array of Parameter

The information of the common parameter.

CreatedBy String root(130900000)

The user who created the common parameter.

CreatedDate String 2020-09-01T08:01:43Z

The time when the common parameter was created.

Description String parameter

The description of the common parameter.

Id String p-4c4b401cab6747xxxxxx

The ID of the common parameter.

Name String MyParameter

The name of the common parameter.

ParameterVersion String 1

The version number of the common parameter.

ShareType String Private

The share type of the common parameter.

Type String String

The data type of the common parameter.

UpdatedBy String root(130900000)

The user who updated the common parameter.

UpdatedDate String 2020-09-01T08:01:43Z

The time when the common parameter was updated.

RequestId String A81E4B2E-6B33-4BAE-9856-55DB7C893E01

The ID of the request.

TotalCount Integer 5

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListParameters
&<Common request parameters>

Sample success responses

XML format

<Parameters>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>String</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description>parameter</Description>
    <UpdatedDate>2020-09-01T08:01:43Z</UpdatedDate>
    <ParameterVersion>1</ParameterVersion>
    <CreatedDate>2020-09-01T08:01:43Z</CreatedDate>
    <Id>p-4c4b401cab6747xxxxxx</Id>
    <Name>MyParameter</Name>
    <ShareType>Private</ShareType>
</Parameters>
<RequestId>A81E4B2E-6B33-4BAE-9856-55DB7C893E01</RequestId>
<NextToken>gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb</NextToken>
<MaxResults>50</MaxResults>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.