すべてのプロダクト
Search

このプロダクト

    :CreateTicket

    ドキュメントセンター

    :CreateTicket

    最終更新日:Jul 02, 2026

    埋め込みレポートアクセスに必須のチケットを生成します。

    操作説明

    詳細については、埋め込みレポートにおけるデータ権限コントロールとパラメーター受け渡しのセキュリティ強化を参照してください。

    今すぐお試しください

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

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorksId

    string

    必須

    埋め込みが有効になっているレポートの ID。ダッシュボード、ワークブック、データ画面、アドホッククエリ、アドホック分析、およびデータ入力フォームがサポートされています。

    a206f5f3-****-e9b17c835b03
    CmptId

    string

    任意

    コンポーネント ID。ダッシュボード内の特定のコンポーネントの ID です。その他のレポートタイプはサポートされていません。 コンポーネント ID を取得するには、 QueryWorksBloodRelationship を参照してください。

    0fc6a275c7f64f17b1****a306ce0f31
    TicketNum

    integer

    任意

    チケットを使用できる回数。チケットがアクセスに使用されるたびに、カウントが 1 減少します。

    • デフォルト値: 1。

    • 推奨値: 1。

    • 最大値: 99999。

    1
    UserId

    string

    任意

    Quick BI ユーザー ID。Alibaba Cloud アカウント ID ではありません。 QueryUserInfoByAccount 操作を呼び出してユーザー ID を取得できます。例: fe67f61a35a94b7da1a34ba174a7****。

    説明

    UserId または AccountName のいずれかを指定してください。どちらも指定されていない場合、デフォルトでレポートのオーナーが使用され、そのユーザーの ID でレポートにアクセスされます。データの行レベル権限を設定するには、行レベル権限を参照してください。

    46e537466****92704c8
    AccountName deprecated

    string

    任意

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

    • ユーザーが Alibaba Cloud アカウント wangwu の場合、フォーマットは [プライマリアカウント] です。例: wangwu。

    • ユーザーが Resource Access Management (RAM) ユーザーアカウント zhangsan@aliyun.cn** の場合、フォーマットは [プライマリアカウント:RAM ユーザー] です。例: wangwu:zhangsan。

    説明

    UserId または AccountName のいずれかを指定してください。どちらも指定されていない場合、デフォルトでレポートのオーナーがソースとして付与され、そのユーザーの ID でレポートにアクセスされます。データの行レベル権限を設定するには、行レベル権限を参照してください。

    test
    AccountType deprecated

    integer

    任意

    ユーザーのアカウントタイプ。有効な値:

    • 1: Alibaba Cloud アカウント

    • 3: Quick BI カスタムアカウント

    • 4: DingTalk

    • 5: RAM ユーザー

    • 9: WeCom

    • 10: Lark

    説明

    AccountName を指定した場合、AccountType も指定する必要があります。

    1
    ExpireTime

    integer

    任意

    有効期限の時間。

    • 単位: 分。

    • デフォルト値: 240。

    200
    WatermarkParam

    string

    任意

    レポートのウォーターマークパラメーター。

    • 値は 50 文字を超えることはできません。

    • レポートタイプがデータ画面の場合、ウォーターマークパラメーターはサポートされていません。

    ticket embed
    GlobalParam

    string

    任意

    グローバルパラメーター。

    [{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    string

    生成されたチケットの値。

    ccd3428c-****-****-a608-26bae29dffee
    Success

    boolean

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

    • true: リクエストが成功しました。

    • false: リクエストが失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": "ccd3428c-****-****-a608-26bae29dffee",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Authorize3rdTicket.BindedWorks.Mismatch The report bound by the ticket mismatches the actual report.
    400 Authorize3rdTicket.Expired Ticket [%s] has expired.
    400 Authorize3rdTicket.HasNo.LoginToken The request [%s] has no token.
    400 Authorize3rdTicket.NotExist Ticket %s does not exist.
    400 Authorize3rdTicket.Num.Exceed The number of tickets %s is invalid.
    400 Authorize3rdTicket.Num.HasNoLeft There is no ticket number left, please generate new ticket.
    400 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 指定されたワークブックは存在しないか、削除されています。ワークブック ID：%s。
    400 Authorize3Rd.Report.Unauthorized The report is not enabled for third party embedding.
    400 Cube.Not.Exist The Cube does not exist.
    400 Datasource.NotFound.Error The specified data source does not exist: %s. 指定されたデータソースは存在しません：%s。
    400 Report.NotExist The dashboard does not exist.
    400 Organization.Workspace.Inconformity The workspace does not match the organization.
    400 Parameter.Length.Exceed Parameter length exceeds maximum limit: [%s].
    400 GlobalParam.Restricted.Use The global parameter function is restricted in your version.
    400 Authorize3rdTicket.Unsupport.ScreenWatermark Screen embed does not support watermark parameters.
    400 NoPermissionTo.Operate.Object You are not authorized to operate the objects.

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

    変更履歴

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