GetSecretParameter - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Queries the information about an encryption parameter, including the parameter value. 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:GetSecretParameter	READ	secretparameter acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
Name	string	Yes	The name of the parameter. The name must be 1 to 180 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.	MySecretParameter
ParameterVersion	integer	No	The version number of the common parameter. Valid values: 1 to 100.	1
WithDecryption	boolean	No	Specifies whether to decrypt the parameter value. The decrypted parameter value is returned only if this parameter is set to true. Otherwise, null is returned.	false

Response parameters

Parameter	Type	Description	Example
	object	The information about the encryption parameter.
RequestId	string	The ID of the request.	7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2
Parameter	object	The information about the encryption parameter.
Type	string	The type of the parameter.	Secret
UpdatedDate	string	The time when the encryption parameter was updated.	2020-09-01T09:35:17Z
UpdatedBy	string	The user who updated the encryption parameter.	root(130900000)
KeyId	string	The ID of the key of Key Management Service (KMS) that is used for encryption.	80e9409f-78fa-42ab-84bd-83f40c******
Tags	object	The tags of the parameter.	{"k1": "v1", "k2": "v2"}
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.	'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'
ResourceGroupId	string	The ID of the resource group.	rg-acfmxsn4m4******
CreatedBy	string	The user who created the encryption parameter.	root(130900000)
CreatedDate	string	The time when the encryption parameter was created.	2020-09-01T09:28:47Z
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-14ed150fdcd048xxxxxx
ShareType	string	The share type of the encryption parameter.	Private

Examples

Sample success responses

JSONformat

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

Error codes

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