GetSecretParameter - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Queries an encrypted parameter, including its value. Before you call this operation, ensure that you have the permissions to call the GetSecretValue API operation of Key Management Service (KMS).

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:GetSecretParameter

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
Name	string	Yes	The name of the parameter. The name can be up to 180 characters in length and can contain letters, digits, hyphens (-), and underscores (_). The name cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.	MySecretParameter
ParameterVersion	integer	No	The version number of the parameter. Valid values: 1 to 100.	1
WithDecryption	boolean	No	Specifies whether to decrypt the parameter value. The Value field in the response is returned only if this parameter is set to true. Otherwise, the Value field is empty.	false

Response elements

Element	Type	Description	Example
	object	The information about the encrypted parameter.
RequestId	string	The request ID.	7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2
Parameter	object	The information about the encrypted parameter.
Type	string	The type of the parameter.	Secret
UpdatedDate	string	The time when the parameter was updated.	2020-09-01T09:35:17Z
UpdatedBy	string	The user who updated the parameter.	root(130900000)
KeyId	string	The ID of the KMS key that is used for encryption.	80e9409f-78fa-42ab-84bd-83f40c******
Tags	object	The tags.	{"k1": "v1", "k2": "v2"}
Value	string	The value of the parameter.	SecretParameter
Description	string	The description of the parameter.	SecretParameter
Constraints	string	The constraints of the parameter.	'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'
ResourceGroupId	string	The ID of the resource group.	rg-acfmxsn4m4******
CreatedBy	string	The user who created the parameter.	root(130900000)
CreatedDate	string	The time when the parameter was created.	2020-09-01T09:28:47Z
ParameterVersion	integer	The version number of the parameter.	1
Name	string	The name of the encrypted parameter.	MySecretParameter
Id	string	The ID of the encrypted parameter.	p-14ed150fdcd048xxxxxx
ShareType	string	The share type of the parameter.	Private
DKMSInstanceId	string	The ID of the KMS instance.	kst-hzz****

Examples

Success response

JSON format

{
  "RequestId": "7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2",
  "Parameter": {
    "Type": "Secret",
    "UpdatedDate": "2020-09-01T09:35:17Z",
    "UpdatedBy": "root(130900000)",
    "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Value": "SecretParameter",
    "Description": "SecretParameter",
    "Constraints": "'{''AllowedValues\":[\"secretparameter\"],\"AllowedPattern\":\".*\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T09:28:47Z",
    "ParameterVersion": 1,
    "Name": "MySecretParameter",
    "Id": "p-14ed150fdcd048xxxxxx",
    "ShareType": "Private",
    "DKMSInstanceId": "kst-hzz****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.