UpdateNamespace API で SAE 名前空間詳細を更新 - SAE - Alibaba Cloud - Serverless App Engine

名前空間の情報を更新します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:UpdateNamespace

update

*All Resource

*

なし

リクエスト構文

PUT /pop/v1/paas/namespace HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NamespaceId	string	任意	名前空間の長い ID です。このパラメーターを設定すると、長い ID が有効になり、`NameSpaceShortId` パラメーターの値は無視されます。互換性を確保するために、短い名前空間 ID を指定することを推奨します。長い名前空間 ID は、`<RegionId>:<NamespaceId>` というフォーマットに従います。`NamespaceId` 変数には、小文字と数字のみを含めることができます。例：`cn-beijing:test`。Namespaceid 変数の値は、長さが 32 文字を超えることはできません。RegionId の詳細については、DescribeRegions 操作を呼び出して、SAE でサポートされているリージョンの ID を取得できます。	cn-beijing:test
NamespaceName	string	必須	名前空間の名前です。名前の長さは 64 文字を超えることはできません。	name
NamespaceDescription	string	任意	名前空間の説明です。説明の長さは 100 文字を超えることはできません。	desc
NameSpaceShortId	string	任意	名前空間の短い ID です。リージョン ID を指定する必要はありません。このパラメーターを設定することを推奨します。このパラメーターの値は、最大 20 文字で、小文字と数字のみを含めることができます。	test
EnableMicroRegistration	boolean	任意	SAE 組み込みレジストリを有効にするかどうかを示します。 true false このパラメーターを true に設定すると、名前空間に共有レジストリが作成されます。レジストリは作成後に無効化することはできません。	true

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	操作に対して返されるメッセージ。	success
TraceId	string	リクエストの詳細を照会するために使用されるトレース ID。	0a98a02315955564772843261e****
Data	object	名前空間に関する情報。
NamespaceDescription	string	名前空間の説明。	desc
NamespaceId	string	名前空間の ID。	cn-beijing:test
NamespaceName	string	名前空間の名前。	name
RegionId	string	名前空間が存在するリージョン。	cn-beijing
NameSpaceShortId	string	名前空間のショート ID。	test
EnableMicroRegistration	boolean	SAE 組み込みレジストリを有効にするかどうかを示します： true false	true
ErrorCode	string	返されるエラーコード。次のルールにご注意ください：リクエストが成功した場合、ErrorCode パラメーターは返されません。呼び出しが失敗した場合、ErrorCode パラメーターが返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	HTTP ステータスコード。有効な値： 2xx：呼び出しは成功しました。 3xx：呼び出しはリダイレクトされました。 4xx：呼び出しは失敗しました。 5xx：サーバーエラーが発生しました。	200
Success	boolean	名前空間の情報が更新されたかどうかを示します。有効な値： true：インスタンスは更新されました。 false：インスタンスの更新に失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "NamespaceDescription": "desc",
    "NamespaceId": "cn-beijing:test",
    "NamespaceName": "name",
    "RegionId": "cn-beijing",
    "NameSpaceShortId": "test",
    "EnableMicroRegistration": true
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidNamespaceName.Format	The specified NamespaceName is invalid. The name of the namespace cannot exceed 63 characters in length.
400	System.Upgrading	The system is being upgraded. Please try again later.
400	Exceed.Namespace	Too many namespaces have been created.
400	InvalidNamespaceId.Format	The specified NamespaceId is invalid.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.

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

変更履歴

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