CreateParameter による共通パラメータ作成 - OOS

共通パラメーターを作成します。

今すぐお試しください

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

create

*parameter

acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}

oos:TLSVersion

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
Name	string	必須	パラメーターの名前。長さは 1～200 文字である必要があります。使用できる文字は、英字、数字、ハイフン (-)、アンダースコア (_) です。ALIYUN、ACS、ALIBABA、ALICLOUD、または OOS で始めることはできません。	MyParameter
Type	string	必須	パラメーターのデータの型。有効な値：String および StringList。	String
Value	string	必須	共通パラメーターの値。長さは 1～4096 文字である必要があります。	parameter
Description	string	任意	共通パラメーターの説明。長さは 1～200 文字である必要があります。	parameter
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンの長さは最大 64 文字で、英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。詳細については、「べき等性を確保する方法」をご参照ください。	123e4567-e89b-12d3-a456-42665544****
Constraints	string	任意	共通パラメーターの制約。デフォルトでは、このパラメーターは null です。有効な値： AllowedValues：共通パラメーターに許可される値。配列文字列である必要があります。 AllowedPattern：共通パラメーターに許可されるパターン。正規表現である必要があります。 MinLength：共通パラメーターの最小長。 MaxLength：共通パラメーターの最大長。	{ "AllowedValues": [ "parameter" ], "AllowedPattern": "parameter", "MinLength": 0, "MaxLength": 20 }
Tags	object	任意	タグ。	{"k1": "v1", "k2": "v2"}
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmxsn4m4******

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF
Parameter	object	共通パラメーターに関する情報。
Type	string	共通パラメーターのタイプ。	String
UpdatedDate	string	共通パラメーターが更新された時間。	2020-09-01T08:01:43Z
UpdatedBy	string	共通パラメーターを更新したユーザー。	root(130900000)
Tags	object	タグ。	{"k1": "v1", "k2": "v2"}
Description	string	共通パラメーターの説明。	parameter
Constraints	string	共通パラメーターの制約。	"{'AllowedValues':['parameter'],'AllowedPattern':'parameter','MinLength':0,'MaxLength':20}"
ResourceGroupId	string	リソースグループ ID。	rg-acfmxsn4m4******
CreatedBy	string	共通パラメーターを作成したユーザー。	root(130900000)
CreatedDate	string	共通パラメーターが作成された時間。	2020-09-01T08:01:43Z
ParameterVersion	integer	共通パラメーターのバージョン番号。	1
Name	string	共通パラメーターの名前。	MyParameter
Id	string	共通パラメーターの ID。	p-4c4b401cab6747xxxxxx
ShareType	string	共通パラメーターの共有タイプ。	Private

例

成功レスポンス

JSONJSON

{
  "RequestId": "0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF",
  "Parameter": {
    "Type": "String",
    "UpdatedDate": "2020-09-01T08:01:43Z",
    "UpdatedBy": "root(130900000)",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Description": "parameter",
    "Constraints": "\"{'AllowedValues':['parameter'],'AllowedPattern':'parameter','MinLength':0,'MaxLength':20}\"",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T08:01:43Z",
    "ParameterVersion": 1,
    "Name": "MyParameter",
    "Id": "p-4c4b401cab6747xxxxxx",
    "ShareType": "Private"
  }
}

エラーコード

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

変更履歴

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