ListSecretParameters - API Reference| Alibaba Cloud Documentation Center

Before you call this operation, make sure that you have the permission to manage Key Management Service (KMS) secrets.

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	ListSecretParameters	The operation that you want to perform. Set the value to ListSecretParameters.
RegionId	String	No	cn-hangzhou	The ID of the region.
Name	String	No	MySecretParameter	The name of the encryption 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	sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA	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)
Path	String	No	/path1/path2/	The path of the encryption parameter. For example, if the name of an encryption parameter is /path/path1/Myparameter, the path of the encryption 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	sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA	The pagination token.
Parameters	Array of Parameter		The information of the encryption parameter.
CreatedBy	String	root(130900000)	The user who created the encryption parameter.
CreatedDate	String	2020-09-01T09:28:47Z	The time when the encryption parameter was created.
Description	String	SecretParameter	The description of the encryption parameter.
Id	String	p-14ed150fdcd048xxxxxx	The ID of the encryption parameter.
Name	String	MySecretParameter	The name of the encryption parameter.
ParameterVersion	String	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-09-01T09:35:17Z	The time when the encryption parameter was updated.
RequestId	String	CA9C6248-AF2A-4AE9-A166-88FD901BBB90	The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<Parameters>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>Secret</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description>SecretParameter</Description>
    <UpdatedDate>2020-09-01T09:35:17Z</UpdatedDate>
    <ParameterVersion>1</ParameterVersion>
    <CreatedDate>2020-09-01T09:28:47Z</CreatedDate>
    <Id>p-14ed150fdcd048xxxxxx</Id>
    <Name>MySecretParameter</Name>
    <ShareType>Private</ShareType>
</Parameters>
<RequestId>CA9C6248-AF2A-4AE9-A166-88FD901BBB90</RequestId>
<NextToken>sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA</NextToken>
<MaxResults>10</MaxResults>

JSON format

{
	"Parameters": [
		{
			"UpdatedBy": "root(130900000)",
			"Type": "Secret",
			"CreatedBy": "root(130900000)",
			"Description": "SecretParameter",
			"UpdatedDate": "2020-09-01T09:35:17Z",
			"ParameterVersion": 1,
			"CreatedDate": "2020-09-01T09:28:47Z",
			"Id": "p-14ed150fdcd048xxxxxx",
			"Name": "MySecretParameter",
			"ShareType": "Private"
        }
        ],
	"RequestId": "CA9C6248-AF2A-4AE9-A166-88FD901BBB90",
    "NextToken": "sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA",
	"MaxResults": 10
}

Error codes

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