すべてのプロダクト
Search

このプロダクト

    :CreateTicket4Copilot

    ドキュメントセンター

    :CreateTicket4Copilot

    最終更新日:May 28, 2026

    Copilot を埋め込むためのチケットを生成します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    quickbi-public:CreateTicket4Copilot

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    CopilotId

    string

    必須

    埋め込む Copilot モジュールの ID。

    ccd3428c-dd23-460c-a608-26bae29dffee
    TicketNum

    integer

    任意

    チケットの使用可能回数。値の範囲は 1～99,999 です。

    • デフォルト：1。

    • 推奨：1。

    • 最大：99,999。

    アクセスごとにチケットの使用量が 1 ずつ減少します。

    1
    UserId

    string

    任意

    Quick BI ユーザーの ID。これは Alibaba Cloud アカウント ID ではありません。QueryUserInfoByAccount API を呼び出してユーザー ID を取得してください。例：fe67f61a35a94b7da1a34ba174a7****。

    重要 注：UserId または AccountName のいずれかを指定します。両方のパラメーターを指定しない場合、チケットはデフォルトで API 呼び出し元にバインドされます。その場合、呼び出し元のアイデンティティに基づいてアクセスが許可されます。

    9c-asdawf-casxcasd-asdasd
    AccountName

    string

    任意

    ユーザーアカウントの名前。

    重要 注：UserId または AccountName のいずれかを指定します。両方のパラメーターを指定しない場合、チケットはデフォルトで API 呼び出し元にバインドされます。その場合、呼び出し元のアイデンティティに基づいてアクセスが許可されます。

    测试用户
    AccountType

    integer

    任意

    ユーザーアカウントのタイプ。

    • 1：Alibaba Cloud アカウント

    • 3：Quick BI ユーザー

    • 4：DingTalk

    • 5：RAM ユーザー

    • 6：サードパーティーアカウント (SAML や OAuth などのプロトコルを使用して統合されたアカウント)

    • 9：WeCom

    • 10：Lark

    重要 注：AccountName を指定する場合、このパラメーターは必須です。

    1
    ExpireTime

    integer

    任意

    チケットの有効期限。

    • 単位：分。最大有効期間は 240 分 (4 時間) です。

    • デフォルト：240 分。

    200

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    string

    生成されたチケット。

    f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 CopilotEmbed.Config.NotFind Can not find copilot embed config with this copilot ID.
    400 Authorize3rdTicket.Num.HasNoLeft There is no ticket number left, please generate new ticket.
    400 Invalid.Param.Error The parameter is invalid. 指定されたパラメーターは無効です。
    400 Authorize3rdTicket.Num.Exceed The number of tickets %s is invalid.

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

    変更履歴

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