すべてのプロダクト
Search

このプロダクト

    CloudOps Orchestration Service:GetSecretParametersByPath

    ドキュメントセンター

    CloudOps Orchestration Service:GetSecretParametersByPath

    最終更新日:Aug 25, 2025

    パスによって暗号化されたパラメータを取得します。 この操作を呼び出す前に、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:GetSecretParametersByPath

    get

    *secretparameter

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID 。

    cn-hangzhou
    Path

    string

    必須

    パラメータのパス。 パスは 200 文字未満の長さである必要があります。 たとえば、パラメータの名前が /secretParameter/mySecretParameter の場合、パラメータのパスは /secretParameter です。

    /secretParameter
    Recursive

    boolean

    任意

    パス内のパラメータを再帰的にクエリするかどうかを指定します。 たとえば、/secretParameter/mySecretParameter と /secretParameter/secretParameter1/mySecretParameter というパラメータがあるとします。 有効な値:

    • true: /secretParameter/mySecretParameter と /secretParameter/secretParameter1/mySecretParameter の両方を返します。

    • false: /secretParameter/mySecretParameter のみ返します。

    false
    NextToken

    string

    任意

    ページネーショントークン。

    MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
    MaxResults

    integer

    任意

    各ページに返すエントリの数。 有効な値: 1 ～ 10 。 デフォルト値: 10 。

    10
    WithDecryption

    boolean

    任意

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

    • true

    • false ( デフォルト )

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    NextToken

    string

    ページネーショントークン。

    gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
    RequestId

    string

    リクエスト ID 。

    25156E99-7437-4590-AA58-2ACA17DE405C
    TotalCount

    integer

    暗号化されたパラメータの総数。

    10
    MaxResults

    integer

    1 ページあたりに返されるエントリの数。

    10
    Parameters

    array<object>

    パラメータに関する情報。

    object

    Type

    string

    パラメータのタイプ。

    Secret
    UpdatedDate

    string

    パラメータが更新された時刻。

    2020-10-21T06:22:48Z
    UpdatedBy

    string

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

    root(130900000)
    KeyId

    string

    キー ID 。

    090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex
    Value

    string

    パラメータの値。

    secretParameter
    Description

    string

    パラメータの説明。

    secretParameter
    Constraints

    string

    パラメータの制約。

    {\"AllowedPattern\": \"^[a-g]*$\"}
    CreatedBy

    string

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

    root(130900000)
    CreatedDate

    string

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

    2020-10-21T06:22:48Z
    ParameterVersion

    integer

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

    1
    Name

    string

    パラメータの名前。

    mySecretParameter
    Id

    string

    パラメータの ID 。

    p-7cdc0000000000000000
    ShareType

    string

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

    Private

    例

    成功レスポンス

    JSONJSON

    {
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "25156E99-7437-4590-AA58-2ACA17DE405C",
  "TotalCount": 10,
  "MaxResults": 10,
  "Parameters": [
    {
      "Type": "Secret",
      "UpdatedDate": "2020-10-21T06:22:48Z",
      "UpdatedBy": "root(130900000)",
      "KeyId": "090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex",
      "Value": "secretParameter",
      "Description": "secretParameter",
      "Constraints": "{\\\"AllowedPattern\\\": \\\"^[a-g]*$\\\"}",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-10-21T06:22:48Z",
      "ParameterVersion": 1,
      "Name": "mySecretParameter",
      "Id": "p-7cdc0000000000000000",
      "ShareType": "Private"
    }
  ]
}

    エラーコード

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

    変更履歴

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