Queries one or more common parameters by path.

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 GetParametersByPath

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

Path String Yes /parameter

The path of the common parameter. The path must be 1 to 200 characters in length. For example, if the name of a common parameter is /parameter/myparameter, the path of the common parameter is /parameter.

RegionId String No cn-hangzhou

The ID of the region.

Recursive Boolean No false

Specifies whether to recursively query encryption parameters from all levels of directories in the specified path. Valid values: true and false. For example, if you want to query the /parameter/myparameter and /parameter/prameter1/myparameter parameters, the valid values specify the parameters to return.

  • true: Returns both of the /parameter/myparameter and /parameter/prameter1/myparameter parameters.
  • false: Returns only the /parameter/myparameter parameter.
NextToken String No MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA

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

MaxResults Integer No 10

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

Response parameters

Parameter Type Example Description
MaxResults Integer 10

The number of entries returned per page.

NextToken String gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC

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

Parameters Array of Parameter

The information of the common parameter.

Constraints String {\"MaxLength\": 2}

The constraints of the common parameter.

CreatedBy String root(130900000)

The user who created the common parameter.

CreatedDate String 2020-10-21T04:03:12Z

The time when the common parameter was created.

Description String parameter

The description of the common parameter.

Id String p-7cdc0000000000000000

The ID of the common parameter.

Name String myParameter

The name of the common parameter.

ParameterVersion Integer 1

The version number of the common parameter.

ShareType String Private

The share type of the common parameter.

Type String StringList

The type of the common parameter.

UpdatedBy String root(130900000)

The user who updated the common parameter.

UpdatedDate String 2020-10-21T04:03:12Z

The time when the common parameter was updated.

Value String "parameter1,parameter2"

The value of the common parameter.

RequestId String 25156E99-7437-4590-AA58-2ACA17DE405C

The ID of the request.

TotalCount Integer 1

The total number of returned entries.

Examples

Sample requests

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

Sample success responses

XML format

<Parameters>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>StringList</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description/>
    <Constraints>{"MaxLength": 2}</Constraints>
    <UpdatedDate>2020-10-21T04:03:12Z</UpdatedDate>
    <ParameterVersion>1</ParameterVersion>
    <CreatedDate>2020-10-21T04:02:40Z</CreatedDate>
    <Value>parameter1,parameter2</Value>
    <Id>p-7cdc0000000000000000</Id>
    <Name>/parameter/myparameter</Name>
    <ShareType>Private</ShareType>
</Parameters>
<RequestId>25156E99-7437-4590-AA58-2ACA17DE405C</RequestId>
<MaxResults>10</MaxResults>

JSON format

{
	"Parameters": [
		{
			"UpdatedBy": "root(130900000)",
			"Type": "StringList",
			"CreatedBy": "root(130900000)",
			"Description": "",
			"Constraints": "{\"MaxLength\": 2}",
			"UpdatedDate": "2020-10-21T04:03:12Z",
			"ParameterVersion": 1,
			"CreatedDate": "2020-10-21T04:02:40Z",
			"Value": "parameter1,parameter2",
			"Id": "p-7cdc0000000000000000",
			"Name": "/parameter/myparameter",
			"ShareType": "Private"
		}
	],
	"RequestId": "25156E99-7437-4590-AA58-2ACA17DE405C",
	"MaxResults": 10
}

Error codes

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