すべてのプロダクト
Search
ドキュメントセンター

CloudOps Orchestration Service:GetSecretParameters

最終更新日:Aug 13, 2025

1 つ以上の暗号化されたパラメータの詳細を取得します。 この操作を使用するには、Key Management Service ( KMS ) の GetSecretValue 操作を呼び出す権限が必要です。

今すぐお試しください

この 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:GetSecretParameters

get

*secretparameter

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

  • oos:TLSVersion
なし

リクエストパラメーター

パラメーター

タイプ

必須 / 任意

説明

RegionId

string

任意

リージョンの ID です。

cn-hangzhou

Names

string

必須

パラメータの名前。 値は、1 ~ 10 個のパラメータ名を含む JSON 配列です。 フォーマットは ["name1", "name2", ...] です。

["secretParameter","secretParameter1"]

WithDecryption

boolean

任意

パラメータ値を復号化するかどうかを指定します。 有効な値:

  • true

  • false ( デフォルト )

false

レスポンスパラメーター

パラメーター

タイプ

説明

object

RequestId

string

リクエストの ID です。

A5320F1D-92D9-44BB-A416-5FC525ED6D57

InvalidParameters

array

無効なパラメータです。

string

無効なパラメータの名前。

[ "InvalidSecretParameter"]

Parameters

array<object>

パラメータの詳細。

object

Type

string

パラメータのタイプ。

Secret

UpdatedDate

string

パラメータが最後に更新された日時。

2020-10-22T03:11:13Z

UpdatedBy

string

パラメータを最後に更新したユーザー。

root(130900000)

KeyId

string

キーの ID です。

ssh-bp67acfmxazb4p****

Tags

object

タグ。

{"k1": "v1", "k2": "v2"}

Value

string

パラメータの値。

secretParameter,secretParameter1

Description

string

パラメータの説明。

secretParameter

Constraints

string

パラメータの制約。

{\"AllowedValues\": [\"test\"]}

ResourceGroupId

string

リソースグループの ID です。

rg-acfmxsn4m4******

CreatedBy

string

パラメータを作成したユーザー。

root(130900000)

CreatedDate

string

パラメータが作成された日時。

2020-10-22T03:11:13Z

ParameterVersion

integer

パラメータのバージョン。

1

Name

string

パラメータの名前。

MySecretParameter

Id

string

パラメータの ID です。

p-7cdc0000000000000000

ShareType

string

パラメータの共有タイプ。

Private

成功レスポンス

JSONJSON

{
  "RequestId": "A5320F1D-92D9-44BB-A416-5FC525ED6D57",
  "InvalidParameters": [
    "[ \"InvalidSecretParameter\"]"
  ],
  "Parameters": [
    {
      "Type": "Secret",
      "UpdatedDate": "2020-10-22T03:11:13Z",
      "UpdatedBy": "root(130900000)",
      "KeyId": "ssh-bp67acfmxazb4p****",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "Value": "secretParameter,secretParameter1",
      "Description": "secretParameter",
      "Constraints": "{\\\"AllowedValues\\\": [\\\"test\\\"]}",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-10-22T03:11:13Z",
      "ParameterVersion": 1,
      "Name": "MySecretParameter",
      "Id": "p-7cdc0000000000000000",
      "ShareType": "Private"
    }
  ]
}

エラーコード

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

変更履歴

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