Updated on 2024-11-06 GMT+08:00

Querying the Service Catalog API List

Function

This API is used to query the service catalog API list.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/service/market

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

Dlm-Type

No

String

Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE.

Content-Type

Yes

String

Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

auth_type

No

String

Authentication mode

Enumerated values:

  • APP: app secret

  • IAM: IAM token

  • NONE: authentication disabled

visibility

No

String

API visibility

Enumerated values:

  • WORKSPACE: visibale to a workspace

  • PROJECT: visible to a project

  • DOMAIN: visible to a tenant

  • SPECIFIC_PROJECT: visible to a specified project

market_sort_type

No

String

Sorting type

Enumerated values:

  • updateTime: update time

  • createTime: creation time

asc_or_desc

No

String

Sorting order

Enumerated values:

  • asc: ascending order

  • desc: descending order

offset

No

Integer

Start coordinate of the query.

limit

No

Integer

Indicates the number of queried records.

is_owner

No

Boolean

Indicates whether to display the owner.

is_authorized

No

Boolean

Indicates whether to display authorized users.

is_update_recently

No

Boolean

Indicates whether to display the latest updates.

is_release_recently

No

Boolean

Indicates whether to display the latest release.

is_hot_recently

No

Boolean

Indicates whether to display the hot-selling status.

success_and_failure_rate

No

Boolean

Indicates whether to display the success rate and failure rate in the last seven days.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of APIs.

apis

Array of AdvancedMallApiDTO objects

API list.

Table 5 AdvancedMallApiDTO

Parameter

Type

Description

id

String

API ID.

name

String

API name

auth_type

String

Authentication mode

Enumerated values:

  • APP: app secret

  • IAM: IAM token

  • NONE: authentication disabled

application_num

Integer

Number of authorized applications.

call_num

Integer

Number of invoked requests.

user_name

String

Creator.

create_time

Long

Time when the bandwidth was specified.

update_time

Long

Update time.

is_owner

Boolean

Indicates whether the API is in the current space.

is_authorized

Boolean

Indicates whether the user is authorized.

is_update_recently

Boolean

Indicates whether the API has been updated in the last three days.

is_release_recently

Boolean

Indicates whether a new product is launched (APIs released within three days).

is_hot_recently

Boolean

Indicates whether the product is a hot-selling product. (Users in other space have applied for the API within three days.)

success_rate

String

Success rate of API calls within seven days.

failure_rate

String

Invoking failure rate within seven days.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Query the service catalog API list.

/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"
}

Example Responses

Status code: 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 Sample Code

The SDK sample code is as follows.

Query the service catalog API list.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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("<YOUR REGION>"))
                .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.VisibilityEnum.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());
        }
    }
}

Query the service catalog API list.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 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("<YOUR REGION>")) \
        .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)

Query the service catalog API list.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Success

400

Bad request