GetSecretParametersByPath - CloudOps Orchestration Service

Queries encryption parameters by path. Make sure that you have the permissions to call the GetSecretValue operation before you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oos:GetSecretParametersByPath	READ	secretparameter acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Path	string	Yes	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.	/secretParameter
Recursive	boolean	No	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 be returned. true: returns both of the /secretParameter/mySecretParameter and /secretParameter/secretParameter1/mySecretParameter parameters. false: returns only the /secretParameter/mySecretParameter parameter.	false
NextToken	string	No	A pagination token. It can be used in the next request to retrieve a new page of results.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 10. Default value: 10.	10
WithDecryption	boolean	No	Specifies whether to decrypt the parameter value. Default value: false. Valid values: true false	true

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestId	string	The request ID.	25156E99-7437-4590-AA58-2ACA17DE405C
TotalCount	integer	The total number of returned entries.	10
MaxResults	integer	The number of entries per page.	10
Parameters	object []	The information about the encryption parameters.
Type	string	The data type of the encryption parameter.	Secret
UpdatedDate	string	The time when the encryption parameter was updated.	2020-10-21T06:22:48Z
UpdatedBy	string	The user who updated the encryption parameter.	root(130900000)
KeyId	string	The ID of the key.	090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex
Value	string	The value of the encryption parameter.	secretParameter
Description	string	The description of the encryption parameter.	secretParameter
Constraints	string	The constraints of the encryption parameter.	{\"AllowedPattern\": \"^[a-g]*$\"}
CreatedBy	string	The user who created the encryption parameter.	root(130900000)
CreatedDate	string	The time when the encryption parameter was updated.	2020-10-21T06:22:48Z
ParameterVersion	integer	The version number of the encryption parameter.	1
Name	string	The name of the encryption parameter.	mySecretParameter
Id	string	The ID of the encryption parameter.	p-7cdc0000000000000000
ShareType	string	The share type of the encryption parameter.	Private

Examples

Sample success responses

JSONformat

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "25156E99-7437-4590-AA58-2ACA17DE405C",
  "TotalCount": 10,
  "MaxResults": 10,
  "Parameters": [
    {
      "Type": "Secret",
      "UpdatedDate": "2020-10-21T06:22:48Z",
      "UpdatedBy": "root(130900000)",
      "KeyId": "090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex",
      "Value": "secretParameter",
      "Description": "secretParameter",
      "Constraints": "{\\\"AllowedPattern\\\": \\\"^[a-g]*$\\\"}",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-10-21T06:22:48Z",
      "ParameterVersion": 1,
      "Name": "mySecretParameter",
      "Id": "p-7cdc0000000000000000",
      "ShareType": "Private"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.