# 查询服务目录API列表 - ListDataServiceMarketApis #### 功能介绍 查询服务目录API列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v1/{project_id}/service/market 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token，使用[Token认证](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0010.html)时必选。通过调用IAM服务的"获取用户Token"接口获取响应消息头中X-Subject-Token的值。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | Dlm-Type | 否 | String | 数据服务的版本类型，指定SHARED共享版或EXCLUSIVE专享版。 | | Content-Type | 是 | String | 消息体的类型（格式），有Body体的情况下必选，没有Body体无需填写。如果请求消息体中含有中文字符，则需要通过charset=utf8指定中文字符集，例如取值为：application/json;charset=utf8。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | auth_type | 否 | String | 认证类型。 枚举值： - APP: app secret认证 - IAM: IAM token认证 - NONE: 无认证 | | visibility | 否 | String | API可见性。 枚举值： - WORKSPACE: 工作空间可见 - PROJECT: 项目可见 - DOMAIN: 租户可见 - SPECIFIC_PROJECT: 指定项目可见 | | market_sort_type | 否 | String | 排序参数。 枚举值： - updateTime: 更新时间 - createTime: 创建时间 | | asc_or_desc | 否 | String | 排序方式。 枚举值： - asc: 升序 - desc: 降序 | | offset | 否 | Integer | 查询起始坐标。 | | limit | 否 | Integer | 查询条数。 | | is_owner | 否 | Boolean | 是否显示拥有者。 | | is_authorized | 否 | Boolean | 是否显示已被授权。 | | is_update_recently | 否 | Boolean | 是否显示最近更新。 | | is_release_recently | 否 | Boolean | 是否显示最近发布。 | | is_hot_recently | 否 | Boolean | 是否显示热销状态。 | | success_and_failure_rate | 否 | Boolean | 是否显示7天内成功率与失败率。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | API总条数。 | | apis | Array of [AdvancedMallApiDTO] objects | API列表。 | 表5AdvancedMallApiDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | API ID。 | | name | String | API名称。 | | auth_type | String | 认证类型。 枚举值： - APP: app secret认证 - IAM: IAM token认证 - NONE: 无认证 | | application_num | Integer | 授权使用的应用数量。 | | call_num | Integer | 被调用量。 | | user_name | String | 创建者。 | | create_time | Long | 创建时间。 | | update_time | Long | 更新时间。 | | is_owner | Boolean | 是否当前空间的API。 | | is_authorized | Boolean | 是否已被授权。 | | is_update_recently | Boolean | 是否最近更新（三天内更新过该API）。 | | is_release_recently | Boolean | 是否新品上市（三天内新发布的API）。 | | is_hot_recently | Boolean | 是否热销产品（三天内有其他空间用户申请该API）。 | | success_rate | String | 7天内调用成功率。 | | failure_rate | String | 7天内调用失败率。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 查询服务目录API列表。 ``` /v1/0833a5737480d53b2f250010d01a7b88/service/market { "is_authorized" : true, "is_hot_recently" : true, "is_owner" : true, "is_release_recently" : true, "is_update_recently" : true, "limit" : 12, "offset" : 0, "success_and_failure_rate" : true, "visibility" : "SPECIFIC_PROJECT" } ``` #### 响应示例 **状态码：200** Success。 ``` { "apis" : [ { "application_num" : 0, "auth_type" : "NONE", "call_num" : 1, "create_time" : 1704420144000, "failure_rate" : null, "id" : "bb110fcffb5f319eb08939e877566d6a", "is_authorized" : null, "is_hot_recently" : null, "is_owner" : null, "is_release_recently" : null, "is_update_recently" : null, "name" : "bug_dws", "success_rate" : null, "update_time" : 1704532548000, "user_name" : "user" } ], "total" : 1 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询服务目录API列表。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListDataServiceMarketApisSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("")) .build(); ListDataServiceMarketApisRequest request = new ListDataServiceMarketApisRequest(); MallParaDTO body = new MallParaDTO(); body.withSuccessAndFailureRate(true); body.withIsHotRecently(true); body.withIsReleaseRecently(true); body.withIsUpdateRecently(true); body.withIsAuthorized(true); body.withIsOwner(true); body.withLimit(12); body.withOffset(0); body.withVisibility(MallParaDTO.MallParaDTO.fromValue("SPECIFIC_PROJECT")); request.withBody(body); try { ListDataServiceMarketApisResponse response = client.listDataServiceMarketApis(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 查询服务目录API列表。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("")) \ .build() try: request = ListDataServiceMarketApisRequest() request.body = MallParaDTO( success_and_failure_rate=True, is_hot_recently=True, is_release_recently=True, is_update_recently=True, is_authorized=True, is_owner=True, limit=12, offset=0, visibility="SPECIFIC_PROJECT" ) response = client.list_data_service_market_apis(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 查询服务目录API列表。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ListDataServiceMarketApisRequest{} successAndFailureRateMallParaDto:= true isHotRecentlyMallParaDto:= true isReleaseRecentlyMallParaDto:= true isUpdateRecentlyMallParaDto:= true isAuthorizedMallParaDto:= true isOwnerMallParaDto:= true limitMallParaDto:= int32(12) offsetMallParaDto:= int32(0) visibilityMallParaDto:= model.GetMallParaDtoVisibilityEnum().SPECIFIC_PROJECT request.Body = &model.MallParaDto{ SuccessAndFailureRate: &successAndFailureRateMallParaDto, IsHotRecently: &isHotRecentlyMallParaDto, IsReleaseRecently: &isReleaseRecentlyMallParaDto, IsUpdateRecently: &isUpdateRecentlyMallParaDto, IsAuthorized: &isAuthorizedMallParaDto, IsOwner: &isOwnerMallParaDto, Limit: &limitMallParaDto, Offset: &offsetMallParaDto, Visibility: &visibilityMallParaDto, } response, err := client.ListDataServiceMarketApis(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=ListDataServiceMarketApis)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success。 | | 400 | BadRequest。 |