すべてのプロダクト
Search

このプロダクト

    CloudOps Orchestration Service:GetSecretParameters

    ドキュメントセンター

    CloudOps Orchestration Service:GetSecretParameters

    最終更新日:Sep 02, 2026

    1 つ以上の暗号化パラメーターの詳細を取得します。この操作を呼び出す前に、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:GetSecretParameters

    get

    *secretparameter

    acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
    • oos:TLSVersion
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    cn-hangzhou
    Names

    string

    必須

    パラメーター名。["xxxxxxxxx", "yyyyyyyyy", … "zzzzzzzzz"] のフォーマットの JSON 配列で複数のパラメーター名を指定できます。最大値は 10 個のパラメーター名です。パラメーター名はカンマ (,) で区切ります。

    ["secretParameter","secretParameter1"]
    WithDecryption

    boolean

    任意

    パラメーター値を復号するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    array

    無効なパラメーター。

    string

    無効なパラメーター名のリスト。

    [ "InvalidSecretParameter"]
    Parameters

    array<object>

    パラメーター情報。

    array<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"
    }
  ]
}

    エラーコード

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

    変更履歴

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