ListTemplate API で一括アーキテクチャテンプレートを取得 - CADT

テンプレートのリストを取得します。リストには、テンプレートの名前、アーキテクチャ図の URL、およびシリアル化されたアーキテクチャ図ファイルの URL が含まれます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

bpstudio:ListTemplate

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	integer	必須	ページ番号。	1
MaxResults	integer	必須	1 ページあたりのエントリ数。	10
OrderType	integer	任意	ソートするフィールド: 1: 更新時間でソートします。 2: 作成時間でソートします。 3: システムの推奨順にソートします。 4: 使用回数でソートします。このパラメーターを指定しない場合、または 1、2、3、4 以外の整数を指定した場合、結果はシステムの推奨順にソートされます。	1
Keyword	string	任意	テンプレート名を検索するためのキーワード。	“CADT”
Type	string	必須	public はパブリックテンプレートを示し、private はプライベートテンプレートを示します。	private
TagList `deprecated`	integer	任意	テンプレートのタグ。	2
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmyjt3c5om3hi
Tag	array<object>	任意	タグのリスト。
	object	任意	タグ情報。
Key	string	任意	タグキー。	tag
Value	string	任意	タグの値。	value

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	エントリの総数。	100
Message	string	エラーメッセージ。	Success
NextToken	integer	ページ番号。	1
RequestId	string	リクエスト ID。	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	array<object>	テンプレートのリスト。
	array<object>
ImageURL	string	テンプレートのイメージ URL。	bp-studio-template/sr-U37UD2YQCRJ75X5V.png
TagId `deprecated`	integer	テンプレートのタグの ID。	1
TagName `deprecated`	string	テンプレートのタグの名前。	TagName
Name	string	テンプレートの名前。	cadt-name
TemplateId	string	テンプレートの ID。	CJQ6H0XUEQ20IYJQ
CreateTime	string	作成時間。	2021-03-18 16:41:31
ResourceGroupId	string	リソースグループ ID。	rg-acfmyjt3c5om3hi
Tag	array<object>	タグのリスト。
	object	タグ情報。
Key	string	タグキー。	tag1
Value	string	タグの値。	value1
Description	string	テンプレートの説明。
DocumentUrl	string	シナリオの詳細。
Code	string	状態コード。	200

例

成功レスポンス

JSONJSON

{
  "TotalCount": 100,
  "Message": "Success",
  "NextToken": 1,
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": [
    {
      "ImageURL": "bp-studio-template/sr-U37UD2YQCRJ75X5V.png",
      "TagId": 1,
      "TagName": "TagName",
      "Name": "cadt-name",
      "TemplateId": "CJQ6H0XUEQ20IYJQ",
      "CreateTime": "2021-03-18 16:41:31",
      "ResourceGroupId": "rg-acfmyjt3c5om3hi",
      "Tag": [
        {
          "Key": "tag1",
          "Value": "value1"
        }
      ],
      "Description": "",
      "DocumentUrl": ""
    }
  ],
  "Code": "200"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
200	Success	The transaction is successful.
400	ParameterEmpty	You must specify the request parameter.
500	ServiceError	A server error occurred. Please try again later.
404	EntityNotExist.ResourceId	The resource does not exist.
404	EntityNotExist.ResourceGroup	The resource group does not exist.

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

変更履歴

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