獲取一個加密參數，包括參數值。請確保在使用該接口前有操作kms GetSecretValue API的權限。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| oos:GetSecretParameter | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
| Name | string | 是 | 參數名稱。取值范圍：內容限制為字母、數字、中劃線、下劃線，長度不能超過 180 字符，且不能以 ALIYUN、ACS、ALIBABA、ALICLOUD、OOS 開頭。 | MySecretParameter |
| ParameterVersion | integer | 否 | 參數版本號。取值范圍：1-100。 | 1 |
| WithDecryption | boolean | 否 | 是否解密參數值。只有參數為 true 時，返回值的 value 才會有結果，否則為空。 | false |
返回參數
示例
正常返回示例
JSON格式
{
"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****"
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-04-18 | OpenAPI 返回結構發生變更 | 查看變更詳情 |