Help Center/CodeArts Pipeline/API Reference/API/Tenant-level open source governance policy management/Querying the Tenant-Level Open Source Governance Policy List
Updated on 2023-11-28 GMT+08:00
View PDF

Querying the Tenant-Level Open Source Governance Policy List

Function

Querying the Tenant-Level Open Source Governance Policy List

URI

GET /v2/{domain_id}/tenant/open-source/rule-sets/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Indicates the tenant ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Policy

creator_name

No

String

Policy Creator Name

limit

No

Integer

Pagination parameter. The default value is 15.

offset

No

Integer

Pagination parameter. The default value is 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number.

data

Array of SimpleOpenSourceRuleSetVO objects

Open Source Governance Policy List

Table 5 SimpleOpenSourceRuleSetVO

Parameter

Type

Description

id

String

Open Source Governance Policy ID

name

String

Open Source Governance Policy Name

level

String

Open Source Governance Policy Level (tenant-tenant-level, project-project-level)

is_valid

Boolean

Available or Not

version

String

Version

operator

String

Operator

is_public

Boolean

System Policy

is_legacy

Boolean

Old Version or Not

operate_time

Long

Operated

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error Message

error_code

String

Error code.

Example Requests

GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/open-source/rule-sets/query?name=&limit=10&offset=20

Example Responses

Status code: 200

OK

{
  "data" : [ {
    "id" : "883f1208ab0048e9aae21a10160982e8",
    "name" : "APITest_4fNOVk",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "2adaff1dea3f477e918c9629be900356",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684987087000
  }, {
    "id" : "17fcabdb890c4342a66349cc74e4115a",
    "name" : "APITest_92A6dQ",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "dc0c2354e7e140959a9fa26119ad558c",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684986715000
  }, {
    "id" : "edb7794d28994f5183ac2bd724665e5d",
    "name" : "CreatePolicy-20230524110450",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "5d88f49a589a44cf9becaf75e72c4922",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684897626000
  }, {
    "id" : "3531812b8c7e4708bcb663c0a454d87b",
    "name" : "NewOsgPolicy-20230524100437",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "4f869bd73e924d639758391d6daa777d",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684897136000
  }, {
    "id" : "c80f598200eb422084ce1f4ebd79d9e5",
    "name" : "Creating an Open Source Governance Policy - 20230523110532",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "25244e5a9b30453aa3d3f89f42f6a1ad",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684811168000
  }, {
    "id" : "da394b4c0d5c48698773afc7642e300a",
    "name" : "Creating an Open Source Governance Policy - 20230523110517",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "35f41b393a49423abe9909ba11fb166d",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684811120000
  }, {
    "id" : "c1824854160b4a24b3b138da804e8dd1",
    "name" : "Creating an Open Source Governance Policy - 20230523110411",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "49b02b100e77481caaae98d4b937f794",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684811056000
  }, {
    "id" : "883397de70e54ff7ad5004a79f727fb2",
    "name" : "APITest_wfm5lq",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "7dc702f60e4741adad0c460a3a120406",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684756995000
  }, {
    "id" : "968c76ef5d704e62ad0ae812a34c03d2",
    "name" : "cjrTest: tenant-level",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "c79cfa5fc11b456f8d22592a87815c9f",
    "operator" : "devcloud_xxx",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1684722851000
  } ],
  "total" : 29
}

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.