全部產品
Search

搜尋本產品

    CloudOps Orchestration Service：GetSecretParametersByPath - 通過路徑擷取加密參數

    文件中心

    CloudOps Orchestration Service：GetSecretParametersByPath - 通過路徑擷取加密參數

    更新時間：Aug 25, 2025

    通過路徑擷取加密參數。請確保在使用該介面前有操作kms GetSecretValue API的許可權。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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

    否

    翻頁標記的 Token。

    MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
    MaxResults

    integer

    否

    分頁大小。取值範圍：1-10。預設為 10。

    10
    WithDecryption

    boolean

    否

    是否解密參數值。 取值範圍：

    • true

    • false（預設）

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    NextToken

    string

    翻頁標記的 Token

    gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
    RequestId

    string

    請求 ID

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

    integer

    查詢到的加密參數總數

    10
    MaxResults

    integer

    分頁大小

    10
    Parameters

    array<object>

    參數資訊

    object

    Type

    string

    參數類型

    Secret
    UpdatedDate

    string

    參數更新時間

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

    string

    參數更新者

    root(130900000)
    KeyId

    string

    金鑰識別碼

    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

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

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