GetSecretParameter API による暗号化パラメータのクエリ - OOS - Alibaba Cloud - CloudOps Orchestration Service

値を含む暗号化パラメーターを取得します。この操作を呼び出す前に、KMS GetSecretValue API オペレーションを呼び出す権限があることを確認してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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 フィールドに値が入力されます。それ以外の場合、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 キーの ID。	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****

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。