Queries the details of one or more encryption parameters. 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 GetSecretParameters

The operation that you want to perform. Set the value to GetSecretParameters.
Names String Yes ["secretParameter","secretParameter1"]

The name of the encryption parameter. Multiple encryption parameters can form a JSON array in the format of ["xxxxxxxxx", "yyyyyyyyy", … "zzzzzzzzz"]. Each JSON array can contain a maximum of 10 encryption parameters. Multiple encryption parameters in the array are separated by commas (,).

RegionId String No cn-hangzhou

The ID of the region.
WithDecryption Boolean No false

Specifies whether to decrypt the parameter value.

Valid values:

  • true
  • false (Default)

Response parameters

Parameter Type Example Description
InvalidParameters List [ "InvalidSecretParameter"]

Invalid encryption parameter.
Parameters Array of Parameter

The information of the encryption parameter.
Constraints String {\"AllowedValues\": [\"test\"]}

The constraints of the encryption parameter.
CreatedBy String root(130900000)

The user who created the encryption parameter.
CreatedDate String 2020-10-22T03:11:13Z

The time when the encryption parameter was created.
Description String secretParameter

The description of the encryption parameter.
Id String p-7cdc0000000000000000

The ID of the encryption parameter.
KeyId String ssh-bp67acfmxazb4p****

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-22T03:11:13Z

The time when the encryption parameter was updated.
Value String secretParameter,secretParameter1

The value of the encryption parameter.
RequestId String A5320F1D-92D9-44BB-A416-5FC525ED6D57

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetSecretParameters
&Names=["secretParameter","secretParameter1"]
&<Common request parameters>

Sample success responses

XML format 

<Parameters>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>Secret</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description/>
    <Constraints>{"AllowedValues": ["test"]}</Constraints>
    <UpdatedDate>2020-10-22T03:11:13Z</UpdatedDate>
    <ParameterVersion>1</ParameterVersion>
    <CreatedDate>2020-10-22T03:11:13Z</CreatedDate>
    <KeyId/>
    <Id>p-7cdc0000000000000000</Id>
    <Name>SecretParameter</Name>
    <ShareType>Private</ShareType>
</Parameters>
<RequestId>A5320F1D-92D9-44BB-A416-5FC525ED6D57</RequestId>
<InvalidParameters>InvalidSecretParameter</InvalidParameters>

JSON format 

{
	"Parameters": [
		{
			"UpdatedBy": "root(130900000)",
			"Type": "Secret",
			"CreatedBy": "root(130900000)",
			"Description": "",
			"Constraints": "{\"AllowedValues\": [\"test\"]}",
			"UpdatedDate": "2020-10-22T03:11:13Z",
			"ParameterVersion": 1,
			"CreatedDate": "2020-10-22T03:11:13Z",
			"KeyId": "",
			"Id": "p-7cdc0000000000000000",
			"Name": "SecretParameter",
			"ShareType": "Private"
		}
	],
	"RequestId": "A5320F1D-92D9-44BB-A416-5FC525ED6D57",
	"InvalidParameters": [
		"InvalidSecretParameter"
	]
}

Error codes

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