通過GetSecretParameter擷取加密參數及其值-系統營運管理-阿里雲

擷取一個加密參數，包括參數值。請確保在使用該介面前有操作kms GetSecretValue API的許可權。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oos:GetSecretParameter

get

*secretparameter

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

oos:TLSVersion

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-hangzhou
Name	string	是	參數名稱。取值範圍：內容限制為字母、數字、中劃線、底線，長度不能超過 180 字元，且不能以 ALIYUN、ACS、ALIBABA、ALICLOUD、OOS 開頭。	MySecretParameter
ParameterVersion	integer	否	參數版本號碼。取值範圍：1-100。	1
WithDecryption	boolean	否	是否解密參數值。只有參數為 true 時，傳回值的 value 才會有結果，否則為空白。	false

返回參數

名稱	類型	描述	樣本值
	object	加密參數的資訊。
RequestId	string	請求 ID。	7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2
Parameter	object	加密參數資訊
Type	string	參數類型	Secret
UpdatedDate	string	參數更新時間	2020-09-01T09:35:17Z
UpdatedBy	string	參數更新者	root(130900000)
KeyId	string	加密使用的 KMS 的 KeyId	80e9409f-78fa-42ab-84bd-83f40c******
Tags	object	標籤	{"k1": "v1", "k2": "v2"}
Value	string	參數內容	SecretParameter
Description	string	參數描述資訊	SecretParameter
Constraints	string	參數約束條件	'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'
ResourceGroupId	string	資源群組 ID	rg-acfmxsn4m4******
CreatedBy	string	參數建立者	root(130900000)
CreatedDate	string	參數建立時間	2020-09-01T09:28:47Z
ParameterVersion	integer	參數版本號碼	1
Name	string	加密參數名稱	MySecretParameter
Id	string	加密參數 Id	p-14ed150fdcd048xxxxxx
ShareType	string	參數共用類型	Private
DKMSInstanceId	string	KMS 執行個體的執行個體 ID。	kst-hzz****

樣本

正常返回樣本

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。