Querying External Tenant Resources

Function

Query external tenant resources.

SLA Item	Definition
Request success rate	≥ 99.9%
Availability	Tier 1
Data consistency	Eventual consistency can be achieved. The duration of inconsistency is less than 1 minute.
Throughput	4000 TPS
TP50 request latency	2 ms
TP99.9 request latency	5 ms

Precautions

None

Calling Method

GET

URI

/rest/dataapi/homs/open-api/v2/cloudresource/instancedata/{resource_type}

Path parameters

Parameter	Mandatory	Type	Value Range	Description
resource_type	Yes	string	ECS EVS EIP OBS BMS ELB VPN DCS DMS RDS GAUSS MODEL_ARTS_INF MODEL_ARTS_TRAIN MODEL_ARTS_MAOS	Resource type

Query parameters

Parameter	Mandatory	Type	Value Range	Description
begin_time	Yes	integer	None	Start time
end_time	Yes	integer	None	End time
offset_value	No	integer	None	Offset: greater than or equal to 0
page_size	No	integer	0–1000	Page size: greater than or equal to 0

Request

Request header parameters

Parameter	Mandatory	Type	Value Range	Description
X-APIG-Appcode	Yes	string	None	AppCode allocated by SRE
x-auth-token	Yes	string	None	IAM authentication token for the calling party APIG
x-hcso-domainid	No	string	None	ID of the accessed tenant. This parameter is mandatory only in HCS Online scenarios.
x-hcso-appcode	Yes	string	None	AppCode allocated by SRE

Request body parameters
None

Sample request

GET /rest/dataapi/homs/open-api/v2/cloudresource/instancedata/{resource_type} HTTP/1.1 
Host: example.com 
Content-Type: application/json 
Accept: application/json
X-APIG-Appcode: xxx 
x-auth-token: xxx 
x-hcso-domainid: xxx
x-hcso-appcode: xxx

Response

Response parameters

Response status code 200: The Data object is returned. The Data object has the following attributes.

Parameter	Mandatory	Type	Value Range	Description
total	Yes	int32	None	Total number of data records
list	Yes	List<Item>	None	Process object information

The Item object has the following attributes.

Parameter	Mandatory	Type	Value Range	Description
accumulate_factor_name	Yes	String	None	Accumulated factor name
accumulate_factor_value	No	String	None	Accumulated factor value
az_code	No	String	None	AZ code
begin_time	No	String	None	Start time
bp_info	No	String	None	Service information
cloud_service_type_code	Yes	String	None	Cloud service type code
csb_params	No	String	None	CSB parameter
enterprise_project_id	No	String	None	Enterprise project ID
error_msg	No	String	None	Error message
extend_params	No	String	None	Extended parameter
extend_params2	No	String	None	Extended parameter 2
record_type	No	String	None	Record type
region_code	Yes	String	None	Region code
relate_parent_resource	No	String	None	Associated parent resource
relate_root_resource	No	String	None	Associated root resource
resource_id	Yes	String	None	Resource ID
resource_spec_code	No	String	None	Resource specification code
resource_type_code	No	String	None	Resource type code
site_code	No	String	None	Site code
tag	No	String	None	Tag
time_stamp	Yes	String	None	Timestamp

Sample response

HTTP/1.1 200 OK
Date:Tue,18 Jul 2023 09:58:01 GMT
Server: example.com
Content-Type: application/json;charset=UTF8
{
    "list": [
             {
             "accumulate_factor_name": "Accumulated factor name",
             "accumulate_factor_value": "Accumulated factor value",
             "az_code": "AZ code",
             "begin_time": "Start time",
             "bp_info": "Service information",
             "cloud_service_type_code": "Cloud service type code",
             "csb_params": "CSB parameter",
             "enterprise_project_id": "Enterprise project ID",
             "error_msg": "Error message",
             "extend_params": "Extended parameter",
             "extend_params2": "Extended parameter 2",
             "record_type": "Record type",
             "region_code": "Region code",
             "relate_parent_resource": "Associated parent resource",
             "relate_root_resource": "Associated root resource",
             "resource_id": "Resource ID",
             "resource_spec_code": "Resource specification code",
             "resource_type_code": "Resource type code",
             "site_code": "Site code",
             "tag": "Tag",
             "time_stamp": "Timestamp",
              }
            ],
            "total": "Total number",
}