すべてのプロダクト
Search

このプロダクト

    :GetTemplate

    ドキュメントセンター

    :GetTemplate

    最終更新日:Dec 22, 2025

    テンプレートイメージとアーキテクチャ図に関する情報を取得します。

    今すぐお試しください

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

    get

    *Template

    acs:bpstudio::{#accountId}:template/{#TemplateId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TemplateId

    string

    必須

    テンプレートの ID。

    XFKR6WYRVS24S07R
    Region

    string

    任意

    テンプレートのリージョン。

    cn-hangzhou
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-aekzhfgmw4e6fwq

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Message

    string

    エラーメッセージ。

    Success
    RequestId

    string

    リクエストの ID。

    A07FFDF2-78FA-1B48-9E38-88E833A93187
    Data

    object

    テンプレートの詳細。

    Description

    string

    テンプレートの説明。

    ImageURL

    string

    テンプレートのアーキテクチャ図ファイルのパス。

    bp-studio-template/sr-U37UD2YQCRJ75X5V.png
    Name

    string

    テンプレートの名前。

    cadt-template
    TemplateId

    string

    テンプレートの ID。

    XFKR6WYRVS24S07R
    CreateTime

    string

    テンプレートが作成された時間。

    2020-09-22 17:08:31
    ResourceGroupId

    string

    リソースグループの ID。

    rg-aekzhfgmw4e6fwq
    Variables

    array<object>

    テンプレート変数の詳細。

    object

    Attribute

    string

    変数の名前。

    instance_name
    DataType

    string

    変数のタイプ。

    String
    DefaultValue

    string

    デフォルト値。

    cadt-app-01
    Variable

    string

    変数の値。

    ${name}
    Options

    string

    DocumentUrl

    string

    シナリオの詳細。

    Code

    string

    リターンコード。

    200

    例

    成功レスポンス

    JSONJSON

    {
  "Message": "Success",
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": {
    "Description": "",
    "ImageURL": "bp-studio-template/sr-U37UD2YQCRJ75X5V.png",
    "Name": "cadt-template",
    "TemplateId": "XFKR6WYRVS24S07R",
    "CreateTime": "2020-09-22 17:08:31",
    "ResourceGroupId": "rg-aekzhfgmw4e6fwq",
    "Variables": [
      {
        "Attribute": "instance_name",
        "DataType": "String",
        "DefaultValue": "cadt-app-01",
        "Variable": "${name}",
        "Options": ""
      }
    ],
    "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.ResourceGroup The resource group does not exist.
    404 EntityNotExist.ResourceId The resource does not exist.

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

    変更履歴

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