Call the GetSecretParametersByPath API to retrieve secret parameters - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Retrieves encryption parameters by path. Make sure that you have the permission to call the KMS GetSecretValue API operation before calling this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oos:GetSecretParametersByPath

get

*secretparameter

acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Path	string	Yes	The parameter path. The path must be fewer than 200 characters. For example, if the parameter is /secretParameter/mySecretParameter, the path of this parameter is /secretParameter.	/secretParameter
Recursive	boolean	No	Specifies whether to recursively query the path. For example, if the parameters /secretParameter/mySecretParameter and /secretParameter/secretParameter1/mySecretParameter exist, valid values: true: Both /secretParameter/mySecretParameter and /secretParameter/secretParameter1/mySecretParameter are returned. false: Only /secretParameter/mySecretParameter is returned.	false
NextToken	string	No	The pagination token.	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. Valid values: true false (default)	true

Response elements

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

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.