Obtaining Shared Embedded Analytics Information
Function
This API is used to obtain shared embedded analytics information.
URI
GET /v1/{project_id}/embeddings/shared/{embed_id}/attributes
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For how to obtain a project ID, see Obtaining a Project ID. |
embed_id |
Yes |
String |
Embedded analytics ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
resource_id |
String |
Resource ID. |
root_resource_id |
String |
Root ID. |
resource_type |
String |
Explanation Enumerated value of the resource type, which is used to specify the type of the authorized object. For example, datasource indicates that the type of the authorized object is a data source. Constraints N/A Value range The enumerated values are:
Default value N/A |
workspace_id |
String |
Workspace ID. |
Example Request
GET https://{host}/v1/{project_id}/embeddings/shared/{embed_id}/attributes
Example Response
Status code: 200
{ "root_resource_id" : "0cc302c0-xxxxxxx-8bdf-0f726fb36eb4", "resource_type" : "screen", "resource_id" : "2befed28-xxxxx-83df-dbc88e47ee12", "workspace_id" : "b8cbb94cce8xxxxxxx7d8e5498af5dd" }
Status Codes
Status Code |
Description |
---|---|
200 |
The request parameters are successfully uploaded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot