すべてのプロダクト
Search

このプロダクト

    CloudOps Orchestration Service:CreateSecretParameter

    ドキュメントセンター

    CloudOps Orchestration Service:CreateSecretParameter

    最終更新日:Dec 21, 2025

    暗号化パラメーターを作成します。この操作を呼び出す前に、Key Management Service (KMS) の CreateSecret 操作を呼び出す権限があることを確認してください。

    今すぐお試しください

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

    create

    *secretparameter

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    cn-hangzhou
    Name

    string

    必須

    パラメーターの名前。名前は 1～180 文字で、英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。ALIYUN、ACS、ALIBABA、ALICLOUD、または OOS で始めることはできません。

    MySecretParameter
    Type

    string

    任意

    パラメーターのタイプ。値を Secret に設定します。

    Secret
    Value

    string

    必須

    暗号化パラメーターの値。値は 1～4096 文字である必要があります。

    SecretParameter
    Description

    string

    任意

    暗号化パラメーターの説明。説明は 1～200 文字である必要があります。

    SecretParameter
    KeyId

    string

    任意

    パラメーターの暗号化に使用される KMS のキー ID。

    80e9409f-78fa-42ab-84bd-83f40c******
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンは最大 64 文字で、英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。詳細については、「べき等性を確保する方法」をご参照ください。

    123e4567-e89b-12d3-a456-42665544****
    Constraints

    string

    任意

    暗号化パラメーターの制約。デフォルトでは、このパラメーターは null です。有効な値：

    • AllowedValues：暗号化パラメーターに許可される値。配列文字列である必要があります。

    • AllowedPattern：暗号化パラメーターに許可されるパターン。正規表現である必要があります。

    • MinLength：暗号化パラメーターの最小長。

    • MaxLength：暗号化パラメーターの最大長。

    '{''AllowedValues":["secretparameter"],"AllowedPattern":"secretparameter","MinLength":0,"MaxLength":20}'
    Tags

    object

    任意

    タグ。

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

    string

    任意

    リソースグループの ID。

    rg-acfmxsn4m4******
    DKMSInstanceId

    string

    任意

    KMS インスタンスのインスタンス ID。

    kst-hzz****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF
    Parameter

    object

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

    Type

    string

    パラメーターのタイプ。

    Secret
    UpdatedDate

    string

    暗号化パラメーターが更新された時間。

    2020-09-01T09:30:36Z
    UpdatedBy

    string

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

    root(130900000)
    KeyId

    string

    パラメーターの暗号化に使用される KMS のキー ID。

    80e9409f-78fa-42ab-84bd-83f40c******
    Tags

    object

    タグ。

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

    string

    暗号化パラメーターの説明。

    SecretParameter
    Constraints

    string

    暗号化パラメーターの制約。

    '{ "AllowedValues": ["secretparameter"], "AllowedPattern": "secretparameter", "MinLength": 0, "MaxLength": 20 }'
    ResourceGroupId

    string

    リソースグループの ID。

    rg-acfmxsn4m4******
    CreatedBy

    string

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

    root(130900000)
    CreatedDate

    string

    暗号化パラメーターが作成された時間。

    2020-09-01T09:30:36Z
    ParameterVersion

    integer

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

    1
    Name

    string

    暗号化パラメーターの名前。

    MyParameter
    Id

    string

    暗号化パラメーターの ID。

    p-0b0fff9919c946xxxxxx
    ShareType

    string

    暗号化パラメーターの共有タイプ。

    Private
    DKMSInstanceId

    string

    KMS インスタンスのインスタンス ID。

    kst-hzz****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF",
  "Parameter": {
    "Type": "Secret",
    "UpdatedDate": "2020-09-01T09:30:36Z",
    "UpdatedBy": "root(130900000)",
    "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Description": "SecretParameter",
    "Constraints": "'{ \t\"AllowedValues\": [\"secretparameter\"], \t\"AllowedPattern\": \"secretparameter\", \t\"MinLength\": 0, \t\"MaxLength\": 20 }'",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T09:30:36Z",
    "ParameterVersion": 1,
    "Name": "MyParameter",
    "Id": "p-0b0fff9919c946xxxxxx",
    "ShareType": "Private",
    "DKMSInstanceId": "kst-hzz****"
  }
}

    エラーコード

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

    変更履歴

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