속성 관리

Console

모든 시스템 속성을 보려면 Google Cloud 콘솔에서 API 허브 > 설정 페이지로 이동합니다. 시스템 속성 탭에서 모든 기존 시스템 속성을 볼 수 있습니다.

REST API

리소스의 모든 시스템 속성을 보려면 다음 API에 GET 요청을 실행합니다.

API에 대한 자세한 내용은 ListAttributes를 참조하세요.

다음 예시에서는 모든 리소스의 시스템 속성을 가져오기 위한 API 호출을 보여줍니다.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-type: application/json" \
-X GET \
https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/attributes?filter=definition_type=SYSTEM_DEFINED

Console

시스템 속성의 값을 추가하려면 다음 단계를 따르세요.

1. Google Cloud 콘솔에서 API 허브 > 설정 페이지로 이동합니다.

   이렇게 하면 속성 탭의 시스템 속성 섹션에 모든 기존 시스템 속성이 표시됩니다.

2. 값을 추가하려는 속성에서 수정을 클릭합니다.

   그러면 속성 수정 창이 열리고 기존 속성 값이 표시됩니다.

3. 새 값을 추가하려면 항목 추가를 클릭한 후 추가할 새 값을 입력합니다.
4. 저장을 클릭합니다.

REST API

Enum 데이터 유형의 시스템 정의 속성에 허용되는 값을 업데이트하려면 다음 API에 PATCH 요청을 실행합니다.

API에 대한 자세한 내용은 UpdateAttribute를 참조하세요.

다음 예시에서는 Business unit 속성 값을 업데이트하기 위한 API 호출을 보여줍니다.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"allowed_values": [
{
"id": "bu1",
"display_name": "Business unit 1",
"description": "The API can be used by business unit 1"
},
{
"id": "bu2",
"display_name": "Business unit 2",
"description": "The API can be used by business unit 2"
},
{
"id": "bu3",
"display_name": "Business unit 3",
"description": "The API can be used by business unit 3"
}]}' \
-X PATCH https://apihub.googleapis.com/v1/projects/test-15/locations/us-central1/attributes/system-business-unit?update_mask=allowed_values 

API 허브가 UpdateAttribute API의 요청 페이로드를 어떻게 해석하는지 이해하는 것이 중요합니다.

• 페이로드에 지정된 값이 이미 있는 경우 API 허브는 페이로드에서 값이 업데이트되었는지 확인한 후 업데이트된 경우 값을 덮어씁니다.
• 페이로드에서 값을 사용할 수 없는 경우 API 허브는 해당 값을 삭제해야 한다고 해석하고 API 허브에서 값을 삭제합니다.
• 페이로드에서 새 값을 사용할 수 있는 경우 API 허브는 속성에 새 값을 추가합니다.

콘솔

모든 사용자 정의 속성을 보려면 Google Cloud 콘솔에서 API 허브 > 설정 페이지로 이동합니다. 속성 탭의 사용자 정의 속성 섹션에서 모든 사용자 정의 속성을 볼 수 있습니다.

REST API

리소스의 모든 사용자 정의 속성을 보려면 다음 API에 GET 요청을 실행합니다.

API에 대한 자세한 내용은 ListAttributes를 참조하세요.

다음 예시는 API 리소스의 사용자 속성을 가져오는 API 호출을 보여줍니다.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-type: application/json" \
-X GET \
https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/attributes?filter=definition_type=USER_DEFINED

콘솔

새 사용자 정의 속성을 추가하려면 다음 단계를 따르세요.

1. Google Cloud 콘솔에서 API 허브 > 설정 페이지로 이동합니다.

   이렇게 하면 속성 탭의 사용자 속성 섹션에 모든 사용자 정의 속성이 표시됩니다.

2. 속성 만들기를 클릭합니다.

   그러면 새 속성 추가 창이 열립니다.

3. 다음 세부정보를 입력합니다.
   • ID: 속성의 고유 식별자를 입력합니다.
     • 이 필드를 비워두면 API 허브에서 자동으로 고유 ID를 생성합니다.
     • 값을 수동으로 입력하려면 모든 속성에서 값이 고유해야 합니다.
   • 이름: 속성의 이름을 입력합니다.
   • 설명: 필요한 경우 속성 설명을 입력합니다.
   • 최대 허용 값: 1~20 사이의 숫자를 입력합니다. 이 설정은 속성에서 가질 수 있는 값의 최대 개수를 지정합니다.
   • 리소스 유형: 리소스 유형을 선택합니다.
   • 데이터 유형: 속성의 데이터 유형을 선택합니다. 데이터 유형에는 String, Enum, JSON이 있습니다. Enum 데이터 유형이 선택된 경우 + 항목 추가를 클릭하고 속성에 허용되는 값을 입력합니다.
4. 만들기를 클릭합니다.

REST API

새 사용자 정의 속성을 추가하려면 다음 API에 POST 요청을 수행합니다.

API에 대한 자세한 내용은 CreateAttribute를 참조하세요.

다음 예시에서는 attribute-01 사용자 정의 속성을 생성하기 위한 API 호출을 보여줍니다.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json"  \
-d '{
"display_name" : "custom attribute",
"description" : "custom attribute details",
"definition_type" : "USER_DEFINED",
"scope" : "API",
"data_type" : "ENUM",
"allowed_values" : [
{
"id" : "value-1",
"display_name" : "Value 1",
"description" : "Value 1 test description",
"immutable" : false,
},
{
"id" : "value-2",
"display_name" : "Value 2",
"description" : "Value 2 test description",
"immutable" : false,
},
],
"cardinality" : 4,
"mandatory" : false
}' \
-X POST  https://apihub.googleapis.com/v1/projects/test-15/locations/us-central1/attributes?attribute_id=attribute-01

콘솔

사용자 정의 속성을 수정하려면 다음 단계를 따르세요.

1. Google Cloud 콘솔에서 API 허브 > 설정 페이지로 이동합니다.

   이렇게 하면 속성 탭의 사용자 속성 섹션에 기존의 모든 사용자 정의 속성이 표시됩니다.

2. 수정하려는 속성에서 수정을 클릭합니다.

   그러면 속성 수정 창이 열리고 기존 속성 값이 표시됩니다.

3. 이름, 설명, 최대 허용 값을 수정할 수 있습니다. Enum 유형의 경우 새 값을 추가할 수 있습니다. Enum 유형의 새 값을 추가하려면 항목 추가를 클릭한 후 추가할 새 값을 입력합니다.
4. 저장을 클릭합니다.

REST API

사용자 정의 속성을 수정하려면 다음 API에 PATCH 요청을 실행합니다.

API에 대한 자세한 내용은 UpdateAttribute를 참조하세요.

다음 예시에서는 API Visibility 사용자 정의 속성을 업데이트하기 위한 API 호출을 보여줍니다.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -d '{"name": "projects/test-15/locations/us-central1/attributes/API Visibility",
    display_name" : "API Visibility Updated", "allowedValues": [
    {
    "id": "internal",
    "displayName": "Internal",
    "description": "The API is visible internally in an organization"
    },
    {
    "id": "external",
    "displayName": "External",
    "description": "The API is visible externally in an organization"
    },
    {
    "id": "public",
    "displayName": "Public",
    "description": "The API is visible public in an organization"
    }
    ]}' \
    -X PATCH https://autopush-apihub.sandbox.googleapis.com/v1/projects/common-dev-15/locations/us-central1/attributes/API Visibility?update_mask=display_name,allowed_values
    

API 허브가 UpdateAttribute API의 요청 페이로드를 어떻게 해석하는지 이해하는 것이 중요합니다.

• 페이로드에 지정된 값이 이미 있는 경우 API 허브는 페이로드에서 값이 업데이트되었는지 확인한 후 업데이트된 경우 값을 덮어씁니다.
• 페이로드에서 값을 사용할 수 없는 경우 API 허브는 해당 값을 삭제해야 한다고 해석하고 API 허브에서 값을 삭제합니다.
• 페이로드에서 새 값을 사용할 수 있는 경우 API 허브는 속성에 새 값을 추가합니다.