Queries one or more encryption parameters by path. Make sure that you have permissions to call this operation.

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 GetSecretParametersByPath

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

Path String Yes /secretParameter

The path of the encryption parameter. The path must be 1 to 200 characters in length. For example, if the name of an encryption parameter is /secretParameter/mySecretParameter, the path of the encryption parameter is /secretParameter.

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 /secretParameter/mySecretParameter and /secretParameter/secretParameter 1/mySecretParameter parameters, the valid values specify the parameters to return.

  • true: Returns both of the /secretParameter/mySecretParameter and /secretParameter/secretParameter1/mySecretParameter 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.

WithDecryption Boolean No true

Specifies whether to decrypt the parameter value.

Valid values:

  • true
  • false (Default)

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 encryption parameter.

Constraints String {\"AllowedPattern\": \"^[a-g]*$\"}

The constraints of the encryption parameter.

CreatedBy String root(130900000)

The user who created the encryption parameter.

CreatedDate String 2020-10-21T06:22:48Z

The time when the encryption parameter was updated.

Description String secretParameter

The description of the encryption parameter.

Id String p-7cdc0000000000000000

The ID of the encryption parameter.

KeyId String 090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex

The AccessKey ID.

Name String mySecretParameter

The name of the encryption parameter.

ParameterVersion Integer 1

The version number of the encryption parameter.

ShareType String Private

The share type of the encryption parameter.

Type String Secret

The data type of the encryption parameter.

UpdatedBy String root(130900000)

The user who updated the encryption parameter.

UpdatedDate String 2020-10-21T06:22:48Z

The time when the encryption parameter was updated.

Value String secretParameter

The value of the encryption parameter.

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

The ID of the request.

TotalCount Integer 10

The total number of returned entries.

Examples

Sample requests

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

Sample success responses

XML format

<Parameters>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>Secret</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description>secretParameter</Description>
    <Constraints>{"AllowedPattern": "^[a-g]*$"}</Constraints>
    <UpdatedDate>2020-10-21T06:22:48Z</UpdatedDate>
    <ParameterVersion>3</ParameterVersion>
    <CreatedDate>2020-10-21T03:28:33Z</CreatedDate>
    <Value>secretParameter</Value>
    <KeyId>090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex</KeyId>
    <Id>p-7cdc0000000000000000</Id>
    <Name>mySecretParameter</Name>
    <ShareType>Private</ShareType>
</Parameters>
<RequestId>14F404A1-0863-4BB3-B884-78FCE6075DA8</RequestId>
<MaxResults>10</MaxResults>

JSON format

{
	"Parameters": [
		{
			"UpdatedBy": "root(130900000)",
			"Type": "Secret",
			"CreatedBy": "root(130900000)",
			"Description": "secretParameter",
			"Constraints": "{\"AllowedPattern\": \"^[a-g]*$\"}",
			"UpdatedDate": "2020-10-21T06:22:48Z",
			"ParameterVersion": 3,
			"CreatedDate": "2020-10-21T03:28:33Z",
            "Value": "secretParameter",
			"KeyId": "090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex",
			"Id": "p-7cdc0000000000000000",
			"Name": "mySecretParameter",
			"ShareType": "Private"
		}
	],
	"RequestId": "14F404A1-0863-4BB3-B884-78FCE6075DA8",
	"MaxResults": 10
}

Error codes

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